Statements / API v1

Get a statement

GET/api/partner/v1/statements/{statementId}

Returns one issued statement scoped to the authenticated partner and key environment.

Authentication

Authorization: Bearer <PARTNER_API_KEY>

Keys, environments, and IP policy

Path parameters

statementIdstringrequired: uuid

Response

Monthly statement detail. Tax aggregates are null only when legacy tax evidence makes the tax state INCOMPLETE.

Cache-Control no-store

dataobjectrequired

Show fields

statementIdstringrequired

uuid

partnerIdstringrequired

uuid

modestringrequired

"LIVE" · "TEST"

settlementModestringrequired

"PREPAID" · "POSTPAID"

periodStartstringrequired

date

periodEndExclusivestringrequired

date

timeZonestringrequired

"Asia/Riyadh"

dueDatestringrequired

date

statusstringrequired

Derived read status. OPEN is intentionally not representable.

"ISSUED" · "PARTIALLY_PAID" · "PAID" · "OVERDUE" · "VOIDED"

settlementStatestringrequired

"NOT_APPLICABLE" · "UNPAID" · "PARTIALLY_PAID" · "PAID" · "OVERDUE"

currencystringrequired

"SAR"

openingBalanceMinorintegerrequired

int64 · min: -9007199254740991 · max: 9007199254740991

closingBalanceMinorintegerrequired

int64 · min: -9007199254740991 · max: 9007199254740991

activityTotalsobjectrequired

Show fields

topUpsMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
orderChargesMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
orderReversalsMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
returnsMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
adjustmentCreditsMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
adjustmentDebitsMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
settlementPaymentsMinorintegerrequired: int64 · min: 0 · max: 9007199254740991

taxobjectrequired

Newly resolved orders freeze a non-null included-tax amount once at integer-minor precision using HALF_UP(grossMinor * rateBasisPoints / (10000 + rateBasisPoints)); zero basis points freezes zero, and reversals reuse the frozen amount. INCOMPLETE is retained for legacy nullable charge/reversal evidence; in that state all aggregate tax amounts are null and are never zero-filled.

Show fields

statestringrequired: "COMPLETE" · "INCOMPLETE"
chargeTaxMinorinteger | nullrequired: int64 · min: 0 · max: 9007199254740991
reversalTaxMinorinteger | nullrequired: int64 · min: 0 · max: 9007199254740991
netTaxMinorinteger | nullrequired: int64 · min: -9007199254740991 · max: 9007199254740991
incompleteLineCountintegerrequired: int32 · min: 0

settlementobjectrequired

Show fields

amountDueMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
paidMinorintegerrequired: int64 · min: 0 · max: 9007199254740991
outstandingMinorintegerrequired: int64 · min: 0 · max: 9007199254740991

lineCountintegerrequired

int64 · min: 0

issuedAtstring | nullrequired

date-time

paidAtstring | nullrequired

date-time

updatedAtstringrequired

date-time

canAllocatebooleanrequired

invoiceRenderingEnabledbooleanrequired

Always false until separate finance and tax approval.

false

requestIdstringrequired

errorobject | nullrequired

null

Need help with your integration?Talk to the GiftU team