Reports

Read workspace payables aging

Read open expense, payout, and asset purchase balances as of end. Aging uses source dates, with credits and advances shown separately; it does not identify overdue payments.

GET/v1/reports/payables

Query parameters

bankAccountId string

Optional bank account id filter or query option.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1G
start string

Calendar date in YYYY-MM-DD format for the reporting period.

Maximum length: 10 characters.

Example2026-01-15
end string

Calendar date in YYYY-MM-DD format for the reporting period.

Maximum length: 10 characters.

Example2026-01-15
range string

Optional range filter or query option.

Allowed values: "all"

Exampleall
timezone string

Optional timezone filter or query option.

Maximum length: 100 characters.

ExampleUTC
clients string[]

Optional clients filter or query option.

at most 500 items

Example1 item
projects string[]

Optional projects filter or query option.

at most 500 items

Example1 item
vendors string[]

Optional vendors filter or query option.

at most 500 items

Example1 item
tags string[]

Optional tags filter or query option.

at most 500 items

Example1 item
invoices string[]

Optional invoices filter or query option.

at most 500 items

Example1 item
expenses string[]

Optional expenses filter or query option.

at most 500 items

Example1 item
recurringExpenses string[]

Optional recurring expenses filter or query option.

at most 500 items

Example1 item
payouts string[]

Optional payouts filter or query option.

at most 500 items

Example1 item

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY
workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
data object

Returned records. Collections and batches use an array; single records use an object.

ShowHide 12 properties
data.currency object

Referenced currency with its opaque ID and ISO 4217 currency code.

ShowHide 3 properties
data.currency.id string

Opaque identifier for this resource or reference.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F
data.currency.code string

ISO 4217 currency code, such as SAR or USD.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleSAR
data.currency.conversion object

Currency conversion quote used for reporting, including source, target, and rate.

ShowHide 3 properties
data.currency.conversion.from string

ISO 4217 code of the source currency in this persisted quote.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleSAR
data.currency.conversion.to string

ISO 4217 code of the target reporting currency in this persisted quote.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleSAR
data.currency.conversion.rate string

Exact decimal conversion rate from the quote source currency to its target currency.

Maximum length: 128 characters.

Example1.00
data.totalOpen number

total open for this report.

Example100
data.totalCredits number

total credits for this report.

Example100
data.totalAdvances number

total advances for this report.

Example100
data.parties object[]

parties for this report.

ShowHide 7 properties
data.parties[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services
data.parties[].name string

Display name of the record.

ExampleNQD record
data.parties[].href string

href within parties.

ExampleConsulting services
data.parties[].open number

open within parties.

Example100
data.parties[].credit number

credit within parties.

Example100
data.parties[].advance number

advance within parties.

Example100
data.parties[].rowCount number

row count within parties.

Example1
data.buckets object[]

buckets for this report.

ShowHide 3 properties
data.buckets[].bucket string

bucket within buckets.

Allowed values: "0_30", "31_60", "61_90", "91_plus"

Example0_30
data.buckets[].open number

open within buckets.

Example100
data.buckets[].rowCount number

row count within buckets.

Example1
data.rows object[]

rows for this report.

ShowHide 16 properties
data.rows[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P
data.rows[].sourceType string

source type within rows.

Allowed values: "expense", "payout", "asset"

Exampleexpense
data.rows[].partyId string

ID of the related party.

ExampleConsulting services
data.rows[].partyName string

party name within rows.

ExampleConsulting services
data.rows[].originalAmount number

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data.rows[].reportingAmount number

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data.rows[].paid number

paid within rows.

Example100
data.rows[].open number

open within rows.

Example100
data.rows[].ageDays number

age days within rows.

Example100
data.rows[].bucket string

bucket within rows.

Allowed values: "0_30", "31_60", "61_90", "91_plus"

Example0_30
data.rows[].negativeKind string

negative kind within rows.

Allowed values: "credit", "advance"

Examplecredit
data.rows[].currency string

Referenced currency with its opaque ID and ISO 4217 currency code.

ExampleConsulting services
data.rows[].partyHref string

party href within rows.

ExampleConsulting services
data.rows[].reportingCurrency string

Referenced currency with its opaque ID and ISO 4217 currency code.

ExampleConsulting services
data.rows[].href string

href within rows.

ExampleConsulting services
data.rows[].sourceDate string

Calendar date in YYYY-MM-DD format for the reporting period.

ExampleConsulting services
data.filters object

filters for this report.

ShowHide 10 properties
data.filters.start string nullable

Calendar date in YYYY-MM-DD format for the reporting period.

Example2026-01-01
data.filters.end string nullable

Calendar date in YYYY-MM-DD format for the reporting period.

Example2026-01-31
data.filters.clients string[] nullable

clients within filters.

Example1 item
data.filters.projects string[] nullable

projects within filters.

Example1 item
data.filters.vendors string[] nullable

vendors within filters.

Example1 item
data.filters.tags string[] nullable

Tags assigned to the record.

Example1 item
data.filters.invoices string[] nullable

invoices within filters.

Example1 item
data.filters.expenses string[] nullable

expenses within filters.

Example1 item
data.filters.recurringExpenses string[] nullable

recurring expenses within filters.

Example1 item
data.filters.payouts string[] nullable

payouts within filters.

Example1 item
data.fiscalStart string

fiscal start for this report.

Example2026-01-01
data.defaultRange object

default range for this report.

ShowHide 2 properties
data.defaultRange.start string

Calendar date in YYYY-MM-DD format for the reporting period.

Example2026-01-01
data.defaultRange.end string

Calendar date in YYYY-MM-DD format for the reporting period.

Example2026-01-31
data.asOfDate string

Calendar date in YYYY-MM-DD format for the reporting period.

ExampleConsulting services
data.generatedAt string

ISO 8601 timestamp for generated.

Example2026-01-15T12:00:00.000Z

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error object

Error details returned for a failed request.

ShowHide 4 properties
error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input
error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.
error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property
error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties
error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items
error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request
error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input
Example 400 response
{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}
View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗