كشوف الحساب / API v1

قائمة كشوف الحساب

GET/api/partner/v1/statements

Lists issued statements for the authenticated partner and key environment. Periods are fully elapsed Asia/Riyadh calendar months; OPEN is never a persisted or public statement status.

المصادقة

Authorization: Bearer <PARTNER_API_KEY>

المفاتيح والبيئات وسياسة IP

معاملات الاستعلام

pageintegerاختياري

default: 1 · min: 1

sizeintegerاختياري

default: 20 · min: 1 · max: 100

statusstringاختياري

Derived read status. OPEN is intentionally not representable.

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

الاستجابة

Paged monthly statements in the authenticated LIVE or TEST environment.

Cache-Control no-store

dataobjectمطلوب

عرض الحقول

itemsarrayمطلوب

عرض الحقول

statementIdstringمطلوب

uuid

partnerIdstringمطلوب

uuid

modestringمطلوب

"LIVE" · "TEST"

settlementModestringمطلوب

"PREPAID" · "POSTPAID"

periodStartstringمطلوب

date

periodEndExclusivestringمطلوب

date

timeZonestringمطلوب

"Asia/Riyadh"

dueDatestringمطلوب

date

statusstringمطلوب

Derived read status. OPEN is intentionally not representable.

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

settlementStatestringمطلوب

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

currencystringمطلوب

"SAR"

openingBalanceMinorintegerمطلوب

int64 · min: -9007199254740991 · max: 9007199254740991

closingBalanceMinorintegerمطلوب

int64 · min: -9007199254740991 · max: 9007199254740991

activityTotalsobjectمطلوب

عرض الحقول

topUpsMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
orderChargesMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
orderReversalsMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
returnsMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
adjustmentCreditsMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
adjustmentDebitsMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
settlementPaymentsMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991

taxobjectمطلوب

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.

عرض الحقول

statestringمطلوب: "COMPLETE" · "INCOMPLETE"
chargeTaxMinorinteger | nullمطلوب: int64 · min: 0 · max: 9007199254740991
reversalTaxMinorinteger | nullمطلوب: int64 · min: 0 · max: 9007199254740991
netTaxMinorinteger | nullمطلوب: int64 · min: -9007199254740991 · max: 9007199254740991
incompleteLineCountintegerمطلوب: int32 · min: 0

settlementobjectمطلوب

عرض الحقول

amountDueMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
paidMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991
outstandingMinorintegerمطلوب: int64 · min: 0 · max: 9007199254740991

lineCountintegerمطلوب

int64 · min: 0

issuedAtstring | nullمطلوب

date-time

paidAtstring | nullمطلوب

date-time

updatedAtstringمطلوب

date-time

canAllocatebooleanمطلوب

invoiceRenderingEnabledbooleanمطلوب

Always false until separate finance and tax approval.

false

paginationobjectمطلوب

عرض الحقول

pageintegerمطلوب
sizeintegerمطلوب
totalintegerمطلوب: int64
totalPagesintegerمطلوب

requestIdstringمطلوب

errorobject | nullمطلوب

null

تحتاج مساعدة في التكامل؟تواصل مع فريق قيفتو