Get an invoice service summary
GET
/v1/organizations/{orgId}/billing/invoices/{invoiceId}/service-summaryAuthorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
or
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
Path parameters
invoiceIdstringrequiredmax length 255 · matches ^in_[A-Za-z0-9_]+$
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
adjustmentsobject[]requiredShow propertiesHide properties
Array of
objectOne of:
object
amountintegerrequiredmin -9007199254740991 · max 9007199254740991
kindstringrequiredlineIdstringrequiredreasonstring | nullrequiredserviceDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
serviceNamestringrequiredobject
amountintegerrequiredmin -9007199254740991 · max 9007199254740991
creditNoteIdstringrequiredissuedAtstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
kindstringrequiredmemostring | nullrequirednumberstringrequiredreasonstring | nullrequiredserviceNamestring | nullrequiredcurrencystringrequiredmatches ^[A-Z]{3}$
invoiceobjectrequiredShow propertiesHide properties
finalizedAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nullidstringrequiredmax length 255 · matches ^in_[A-Za-z0-9_]+$
invoiceDatestring<date> | nullrequiredShow propertiesHide properties
Any of:
string<date>
string<date>null
nullnumberstring | nullrequiredstateobjectrequiredShow propertiesHide properties
One of:
object
stagestringrequiredobject
stagestringrequiredstatusstringrequiredAllowed:
openpaiduncollectiblevoidobject
stagestringrequiredreconciliationobjectrequiredShow propertiesHide properties
amountMismatchLineIdsstring[]requiredinvoiceTotalintegerrequiredmin -9007199254740991 · max 9007199254740991
reconciledbooleanrequiredsummaryTotalintegerrequiredmin -9007199254740991 · max 9007199254740991
unattributedAmountintegerrequiredmin -9007199254740991 · max 9007199254740991
unattributedLineCountintegerrequiredmin 0 · max 9007199254740991
servicePeriodobjectrequiredShow propertiesHide properties
One of:
object
endDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
sourcestringrequiredAllowed:
invoice_metadatacharge_service_datesinvoice_line_periodsstartDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
statusstringrequiredobject
statusstringrequiredservicesobject[]requiredShow propertiesHide properties
Array of
objectamountintegerrequiredmin -9007199254740991 · max 9007199254740991
firstServiceDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
lastServiceDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
linesobject[]requiredmin items 1
Show propertiesHide properties
Array of
objectamountintegerrequiredmin -9007199254740991 · max 9007199254740991
descriptionstring | nullrequiredlineIdstringrequiredquantitystring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullratestring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullreferencesobjectrequiredShow propertiesHide properties
orderNumbersstring[]requiredpurchaseOrderNumbersstring[]requiredserviceDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
quantitystring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullratestring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullserviceNamestringrequiredunitstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nulltermsobjectrequiredShow propertiesHide properties
disputeWindowobjectrequiredShow propertiesHide properties
One of:
object
daysintegerrequiredmin 0 · max 9007199254740991
deadlinestring<date> | nullrequiredShow propertiesHide properties
Any of:
string<date>
string<date>null
nullstatusstringrequiredobject
statusstringrequiredpaymentTermsobjectrequiredShow propertiesHide properties
One of:
object
daysintegerrequiredmin 0 · max 9007199254740991
labelstringrequiredstatusstringrequiredobject
statusstringrequiredtotalsobjectrequiredShow propertiesHide properties
chargeCorrectionsintegerrequiredmin -9007199254740991 · max 9007199254740991
creditNotesintegerrequiredmin -9007199254740991 · max 9007199254740991
subtotalintegerrequiredmin -9007199254740991 · max 9007199254740991
totalintegerrequiredmin -9007199254740991 · max 9007199254740991
totalAfterCreditsintegerrequiredmin -9007199254740991 · max 9007199254740991
unattributedLinesobject[]requiredShow propertiesHide properties
Array of
objectamountintegerrequiredmin -9007199254740991 · max 9007199254740991
descriptionstring | nullrequiredlineIdstringrequiredperiodEndDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
periodStartDatestring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
quantitynumber | nullrequiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired