Skip to content
Indiana
Dashboard
Docs
Browse docs / Read invoice details

Read invoice details

POST/api/v1/billing/invoices/detail

Page through verified product and usage items of the customer's invoice, preserving rates, quantities, tax, discounts, payments and refunds.

SDK 0.0.1Updated

Make the request

Page through verified product and usage items of the customer's invoice, preserving rates, quantities, tax, discounts, payments and refunds.

Credential
Server API key or customer token. Customer calls cannot select another customer.
Permission
billing:read
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/billing/invoices/detail" \  -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001",  "invoiceId": "00000000-0000-4000-8000-000000000001",  "after": null,  "limit": 50}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

invoiceIduuidRequired

The invoiceId value for this operation. Its accepted type and constraints are listed above and below.

afterstring | nullRequired

The after value for this operation. Its accepted type and constraints are listed above and below.

limitintegerRequired

Maximum records per page, subject to the contract limit.

min: 1 · max: 100

customerIduuidOptional

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

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"

detailobjectRequired

The detail value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
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.

sourceKindenumRequired

The sourceKind value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"product""usage"

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

"accruing""open""pending""paid""failed""void"

currencyenumRequired

Currency code supported by the published price.

Show allowed values

"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"

startsAtdate-timeRequired

The startsAt value for this operation. Its accepted type and constraints are listed above and below.

endsAtdate-timeRequired

The endsAt 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: ^(0|[1-9]\d{0,14})$

grossAmountMinorstringRequired

The grossAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

discountMinorstringRequired

The discountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

paidAmountMinorstringRequired

The paidAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

refundedAmountMinorstringRequired

The refundedAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

createdAtdate-timeRequired

ISO 8601 UTC time when the record was created.

hostedInvoiceUrluri | nullRequired

The hostedInvoiceUrl value for this operation. Its accepted type and constraints are listed above and below.

adjustmentobject | nullRequired

The adjustment value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
originalInvoiceIduuidRequired

The originalInvoiceId 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: ^-?(0|[1-9]\d{0,8})$

acceptedAtdate-time | nullRequired

The acceptedAt 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: 100

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

entitlementIduuidRequired

The entitlementId value for this operation. Its accepted type and constraints are listed above and below.

entitlementVersionIduuidRequired

The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.

productVersionIduuidRequired

The productVersionId value for this operation. Its accepted type and constraints are listed above and below.

authorizationIduuidRequired

The authorizationId value for this operation. Its accepted type and constraints are listed above and below.

entityIduuid | nullRequired

Entity ID within the current customer scope, for configured entity and license features.

unitsobjectRequired

The units 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: ^(0|[1-9]\d{0,17})(\.\d{1,30})?$

cashPriceobjectRequired

The cashPrice value for this operation. Its accepted type and constraints are listed above and below.

linesLimitedbooleanRequired

The linesLimited value for this operation. Its accepted type and constraints are listed above and below.

itemsarrayRequired

The items value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 100

Show child fields
kind"product" | "invoice_credit" | "usage"Required

The kind value for this operation. Its accepted type and constraints are listed above and below.

keystring | string | stringRequired

The key value for this operation. Its accepted type and constraints are listed above and below.

productVersionIduuidOptional

The productVersionId value for this operation. Its accepted type and constraints are listed above and below.

productNamestringOptional

The productName value for this operation. Its accepted type and constraints are listed above and below.

itemKeystringOptional

The itemKey value for this operation. Its accepted type and constraints are listed above and below.

entityIduuid | nullOptional

Entity ID within the current customer scope, for configured entity and license features.

quantityintegerOptional

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.

max: 9007199254740991

subtotalMinorstringOptional

The subtotalMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^-?\d+$

discountMinorstringOptional

The discountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^\d+$

taxMinorstringOptional

The taxMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^-?\d+$

totalMinorstringOptional

The totalMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^-?\d+$

startsAtdate-timeOptional

The startsAt value for this operation. Its accepted type and constraints are listed above and below.

endsAtdate-timeOptional

The endsAt value for this operation. Its accepted type and constraints are listed above and below.

providerLineIdstring | nullOptional

The providerLineId value for this operation. Its accepted type and constraints are listed above and below.

providerItemIdstring | string | nullOptional

The providerItemId value for this operation. Its accepted type and constraints are listed above and below.

entitlementIduuid | uuidOptional

The entitlementId value for this operation. Its accepted type and constraints are listed above and below.

entitlementVersionIduuid | uuidOptional

The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.

creditVersionIduuidOptional

The creditVersionId value for this operation. Its accepted type and constraints are listed above and below.

namestring | stringOptional

Display name of the customer or object; not an identity key.

unitsobject | objectOptional

The units value for this operation. Its accepted type and constraints are listed above and below.

reservedobject | objectOptional

The reserved value for this operation. Its accepted type and constraints are listed above and below.

amountMinorstring | stringOptional

The amountMinor value for this operation. Its accepted type and constraints are listed above and below.

grossAmountMinorstringOptional

The grossAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,17})(\.\d{1,30})?$

creditsAppliedMinorstringOptional

The creditsAppliedMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,17})(\.\d{1,30})?$

propertiesobjectOptional

Validated pricing properties used to match dimensions and multipliers.

cashPriceobject | objectOptional

The cashPrice value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
currencyenum | enumRequired

Currency code supported by the published price.

pricingobject | object | object | objectRequired

The pricing value for this operation. Its accepted type and constraints are listed above and below.

billingCycleobject | objectOptional

The billingCycle value for this operation. Its accepted type and constraints are listed above and below.

creditProviderItemIdstring | nullOptional

The creditProviderItemId value for this operation. Its accepted type and constraints are listed above and below.

nextCursorstring | nullRequired

Next-page cursor; null means end. Pass unchanged and clear when filters change.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse 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.

Related:All request and error conventions·Back to endpoint index