Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

Get an invoice service summary

GET/v1/organizations/{orgId}/billing/invoices/{invoiceId}/service-summary
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-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
invoiceIdstringrequired
max length 255 · matches ^in_[A-Za-z0-9_]+$
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200

Success

dataobjectrequired
Show properties
adjustmentsobject[]required
Show properties
Array of object
One of:
object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
kindstringrequired
lineIdstringrequired
reasonstring | nullrequired
serviceDatestring<date>required
matches ^(?:(?:\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])))$
serviceNamestringrequired
object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
creditNoteIdstringrequired
issuedAtstring<date-time>required
matches ^(?:(?:\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))$
kindstringrequired
memostring | nullrequired
numberstringrequired
reasonstring | nullrequired
serviceNamestring | nullrequired
currencystringrequired
matches ^[A-Z]{3}$
invoiceobjectrequired
Show properties
finalizedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
idstringrequired
max length 255 · matches ^in_[A-Za-z0-9_]+$
invoiceDatestring<date> | nullrequired
Show properties
Any of:
string<date>
string<date>
null
null
numberstring | nullrequired
stateobjectrequired
Show properties
One of:
object
stagestringrequired
object
stagestringrequired
statusstringrequired
Allowed:openpaiduncollectiblevoid
object
stagestringrequired
reconciliationobjectrequired
Show properties
amountMismatchLineIdsstring[]required
invoiceTotalintegerrequired
min -9007199254740991 · max 9007199254740991
reconciledbooleanrequired
summaryTotalintegerrequired
min -9007199254740991 · max 9007199254740991
unattributedAmountintegerrequired
min -9007199254740991 · max 9007199254740991
unattributedLineCountintegerrequired
min 0 · max 9007199254740991
servicePeriodobjectrequired
Show properties
One of:
object
endDatestring<date>required
matches ^(?:(?:\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])))$
sourcestringrequired
Allowed:invoice_metadatacharge_service_datesinvoice_line_periods
startDatestring<date>required
matches ^(?:(?:\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])))$
statusstringrequired
object
statusstringrequired
servicesobject[]required
Show properties
Array of object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
firstServiceDatestring<date>required
matches ^(?:(?:\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>required
matches ^(?:(?:\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[]required
min items 1
Show properties
Array of object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
descriptionstring | nullrequired
lineIdstringrequired
quantitystring | nullrequired
Show properties
Any of:
string
string
null
null
ratestring | nullrequired
Show properties
Any of:
string
string
null
null
referencesobjectrequired
Show properties
orderNumbersstring[]required
purchaseOrderNumbersstring[]required
serviceDatestring<date>required
matches ^(?:(?:\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 | nullrequired
Show properties
Any of:
string
string
null
null
ratestring | nullrequired
Show properties
Any of:
string
string
null
null
serviceNamestringrequired
unitstring | nullrequired
Show properties
Any of:
string
string
null
null
termsobjectrequired
Show properties
disputeWindowobjectrequired
Show properties
One of:
object
daysintegerrequired
min 0 · max 9007199254740991
deadlinestring<date> | nullrequired
Show properties
Any of:
string<date>
string<date>
null
null
statusstringrequired
object
statusstringrequired
paymentTermsobjectrequired
Show properties
One of:
object
daysintegerrequired
min 0 · max 9007199254740991
labelstringrequired
statusstringrequired
object
statusstringrequired
totalsobjectrequired
Show properties
chargeCorrectionsintegerrequired
min -9007199254740991 · max 9007199254740991
creditNotesintegerrequired
min -9007199254740991 · max 9007199254740991
subtotalintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
totalAfterCreditsintegerrequired
min -9007199254740991 · max 9007199254740991
unattributedLinesobject[]required
Show properties
Array of object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
descriptionstring | nullrequired
lineIdstringrequired
periodEndDatestring<date>required
matches ^(?:(?:\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>required
matches ^(?:(?:\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 | nullrequired
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/billing/invoices/string/service-summary' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "adjustments": [
      {
        "amount": -9007199254740991,
        "kind": "charge_correction",
        "lineId": "string",
        "reason": "string",
        "serviceDate": "2019-08-24",
        "serviceName": "string"
      }
    ],
    "currency": "string",
    "invoice": {
      "finalizedAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "invoiceDate": "2019-08-24",
      "number": "string",
      "state": {
        "stage": "draft"
      }
    },
    "reconciliation": {
      "amountMismatchLineIds": [
        "string"
      ],
      "invoiceTotal": -9007199254740991,
      "reconciled": true,
      "summaryTotal": -9007199254740991,
      "unattributedAmount": -9007199254740991,
      "unattributedLineCount": 0
    },
    "servicePeriod": {
      "endDate": "2019-08-24",
      "source": "invoice_metadata",
      "startDate": "2019-08-24",
      "status": "known"
    },
    "services": [
      {
        "amount": -9007199254740991,
        "firstServiceDate": "2019-08-24",
        "lastServiceDate": "2019-08-24",
        "lines": [
          {
            "amount": -9007199254740991,
            "description": "string",
            "lineId": "string",
            "quantity": "string",
            "rate": "string",
            "references": {
              "orderNumbers": [
                "string"
              ],
              "purchaseOrderNumbers": [
                "string"
              ]
            },
            "serviceDate": "2019-08-24"
          }
        ],
        "quantity": "string",
        "rate": "string",
        "serviceName": "string",
        "unit": "unit"
      }
    ],
    "terms": {
      "disputeWindow": {
        "days": 0,
        "deadline": "2019-08-24",
        "status": "known"
      },
      "paymentTerms": {
        "days": 0,
        "label": "string",
        "status": "known"
      }
    },
    "totals": {
      "chargeCorrections": -9007199254740991,
      "creditNotes": -9007199254740991,
      "subtotal": -9007199254740991,
      "total": -9007199254740991,
      "totalAfterCredits": -9007199254740991
    },
    "unattributedLines": [
      {
        "amount": -9007199254740991,
        "description": "string",
        "lineId": "string",
        "periodEndDate": "2019-08-24",
        "periodStartDate": "2019-08-24",
        "quantity": 0
      }
    ]
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?