Skip to main content
GET
List customer balances
Read-only report: nothing on this page can be created, updated or deleted through the API.
  • AsOfDate (optional, date + time, ISO 8601 — e.g. 2026-09-25T14:30:00) counts only movements strictly before this date and time; if omitted, the current date and time is used. For example, sending 2026-09-25T00:00:00 excludes the 25th itself (from 00:00 onward) and everything after, including only movements up to the 24th; sending 2026-09-25T14:30:00 includes movements up to 14:30 on September 25th (that moment itself excluded) — adjust the time to get the balance at any point within a day.
  • There is no StartDate: this differs from the customer transactions report, which has a date range. Here there is only a single cutoff, and all history up to that point is summed.
  • The response is grouped per customer: each customer has CustomerCode/CustomerName and a Balances list (per-currency Debit/Credit/Balance). A customer with movements in more than one currency has more than one entry in Balances.
  • Only customers with at least one movement before AsOfDate appear; customers with no movements at all are not returned.
  • ExcludeZeroBalance (optional, defaults to false): when true, currency entries whose balance is exactly 0 are left out of Balances; a customer whose every currency nets to 0 is left out of the list entirely (it does not come back with an empty Balances). This filter applies before pagination, so TotalCount and page contents reflect it too.
  • MinAbsoluteBalance (optional, number): when set, currency entries whose balance’s absolute value is less than or equal to this threshold are left out of Balances (e.g. sending 100 excludes everything from -100 to 100 inclusive — only balances with an absolute value strictly greater than 100 remain). Useful for filtering out small residual balances (e.g. rounding differences); can be combined with ExcludeZeroBalance. This filter also applies before pagination.
  • Pagination (page/pageSize, up to 50) is over the number of customers; a customer’s currencies always stay on the same page. There is no search parameter.
  • Balance = Debit - Credit; a positive value means the customer owes the company.

Error codes

This endpoint has no endpoint-specific error codes. The general errors that apply to every endpoint (authentication, permissions, request headers, daily limit) still apply.

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

Query Parameters

page
integer<int32>
default:1

Page number, starting at 1. Defaults to 1.

pageSize
integer<int32>
default:50

Items per page, up to 50. Defaults to 50.

asOfDate
string<date-time>

Only movements strictly before this date and time are included (e.g. sending the 25th excludes the 25th itself as well as later dates). ISO 8601, for example 2026-09-25T14:30:00. Defaults to the current date and time when omitted.

excludeZeroBalance
boolean
default:false

When true, currencies whose balance is exactly 0 are left out of Balances; a customer whose every currency nets to 0 is left out entirely. Defaults to false.

minAbsoluteBalance
number<double>

When set, currencies whose balance's absolute value is less than or equal to this are left out of Balances (e.g. 100 excludes everything from -100 to 100 inclusive); a customer whose every currency is filtered out this way is left out entirely. Can be combined with excludeZeroBalance. Omit for no threshold.

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.