API ReferenceInvoice View Sessions

Get invoice view session by ID

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

session_idstringRequired

Response

Single invoice view session
idstring
Session ID
invoice_idstring
Invoice ID
user_idstring
User ID
user_namestring
User name
session_starteddatetime
Session start time
session_endeddatetime or null
Session end time
last_heartbeatdatetime
Last heartbeat
duration_secondsinteger or null
Duration in seconds
created_atdatetime
Created at
active_duration_secondsinteger or null
Active duration in seconds
engaged_duration_secondsinteger or null
Engaged duration in seconds
idle_countinteger or null
Idle count

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error