Skip to content
Generated from the production schema (commit fbf0d6e).

RetailerStatement

Kind: Object

A retailer’s statement of account for one period.

Field Type Description
id ID!
number String!
status RetailerStatementStatus!
periodStart DateTime!
periodEnd DateTime!
issuedAt DateTime!
dueDate Date!
entryCount Int!
openingBalancePaise Int!
salesPaise Int!
creditsPaise Int!
adjustmentsPaise Int!
receiptsPaise Int!
closingBalancePaise Int!
amountReceivedPaise Int!
outstandingPaise Int! What is still to be collected on this statement.
overdue Boolean!
marginPaise Int! What the retailer earned in the period. Memo only.
taxablePaise Int! Tax on the taxed movement only. It deliberately does not foot to the closing balance, because receipts and adjustments carry no tax.
cgstPaise Int!
sgstPaise Int!
igstPaise Int!
disclaimer String! Printed on the document: this is not a tax invoice.
statementUrl String The statement PDF, rendered on first request — so the first call is slow and a null here means rendering failed, not that it is still coming. Something to download, print, or hand to an accountant. Served from our storage: absolute when object storage is configured, otherwise a path relative to the API origin — resolve it before use. Expires, so fetch it fresh rather than storing it.
dealerName String!
lines [RetailerStatementLine!]!