The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
customerIduuidRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
invoiceIduuidRequired
The invoiceId value for this operation. Its accepted type and constraints are listed above and below.
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
invoiceobjectRequired
The invoice value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
customerIduuidRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
providerInvoiceIdstring | nullRequired
The providerInvoiceId value for this operation. Its accepted type and constraints are listed above and below.
statusenumRequired
The status value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"draft""open""paid""void""uncollectible"
currencystringRequired
Currency code supported by the published price.
totalMinorstringRequired
The totalMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^-?\d+$
paidMinorstringRequired
The paidMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^\d+$
refundedMinorstringRequired
The refundedMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^\d+$
hostedInvoiceUrluri | nullRequired
The hostedInvoiceUrl value for this operation. Its accepted type and constraints are listed above and below.
createdAtnumberRequired
ISO 8601 UTC time when the record was created.
collectionMethodenum | nullRequired
The collectionMethod value for this operation. Its accepted type and constraints are listed above and below.
linesarrayRequired
The lines value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 1000
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
descriptionstringRequired
The description value for this operation. Its accepted type and constraints are listed above and below.
amountMinorstringRequired
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^-?\d+$
netAmountMinorstringRequired
The netAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^-?\d+$
quantitynumber | nullRequired
Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.
periodStartnumber | nullRequired
The periodStart value for this operation. Its accepted type and constraints are listed above and below.
periodEndnumber | nullRequired
The periodEnd value for this operation. Its accepted type and constraints are listed above and below.
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery
Verify the key or refresh the expired customer token once.
FORBIDDEN
Recovery
Check current key permissions and customer access.
INVALID_REQUEST
Recovery
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Recovery
Use the App and environment bound to the credential.