Skip to main content
GET
Get customer statement
Read-only report: nothing on this page can be created, updated or deleted through the API. The response has two lists: Lines (the ledger) and Totals (grand total per currency).
  • StartDate and EndDate are required (1023/1024) and define the date range (inclusive) by document date. EndDate cannot be before StartDate (1025).
  • CurrencyId narrows both Lines and Totals to one currency; omit it to get every currency.
  • Lines are ordered by document date, then by internal document order.
  • Lines[].Balance is a running balance per currency: it is the cumulative Debit − Credit for that specific currency up to and including this line, not a single consolidated total across currencies. When the customer has movements in more than one currency, each currency has its own running sequence.
  • Totals has one row per currency that appears in Lines, with the grand total (sum of Debit minus sum of Credit) for that currency over the whole date range — this equals the last line’s Balance for that currency. Each row also carries the currency’s short code and whether it is the company’s default currency.
  • Lines[].TransactionType is the raw document type code; TransactionTypeName is its resolved English name, from the table below.
  • Lines[].TransactionAmount/TransactionCurrencyId hold the original document amount and currency when it can differ from Debit/Credit/CurrencyId (e.g. a bank transfer booked in the account’s currency but posted to the customer in another). They are null when the line’s own currency already matches the document’s currency, since Debit/Credit already represent it in that case — this is expected for most invoice/order lines, not a missing value.
  • Lines[].InstallmentCount is the number of payment installments linked to this transaction; 0 when there are none.

Transaction types

TransactionType identifies the kind of document behind the line.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

customerId
string<uuid>
required

Customer ID.

Query Parameters

startDate
string<date-time>

Required. Start of the date range (inclusive).

endDate
string<date-time>

Required. End of the date range (inclusive). Cannot be before StartDate.

currencyId
string<uuid>

Only include lines in this currency, from GET /api/v1/definitions/currencies. When empty, all currencies are included.

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required

Response data. Null when Success is false.

Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.