List workspace financial movements

GET/v1/reports/movements

Query parameters

start string required

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

Maximum length: 10 characters.

Example2026-01-15

end string required

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

Maximum length: 10 characters.

Example2026-01-15

timezone string

Optional timezone filter or query option.

Maximum length: 100 characters.

ExampleUTC

direction string

Optional direction filter or query option.

Allowed values: "inbound", "outbound"

Exampleinbound

page string

One-based page number for this resource directory.

pattern ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$

Example25

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 4 properties

data.reportingCurrency string

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

ExampleConsulting services

data.totals object

totals for this report.

ShowHide 4 properties

data.totals.inbound string

inbound within totals.

Example100.00

data.totals.outbound string

outbound within totals.

Example100.00

data.totals.net string

Total before tax and other modifiers.

Example100.00

data.totals.missingConversion boolean

missing conversion within totals.

Exampletrue

data.rows object[]

rows for this report.

ShowHide 10 properties

data.rows[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P

data.rows[].sourceId string

ID of the related source.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P

data.rows[].source object

source within rows.

ShowHide 2 properties

data.rows[].source.id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P

data.rows[].source.type string

Type of the record or operation.

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

Exampleinvoice

data.rows[].amount string

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

Example100.00

data.rows[].reportingAmount string

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

Example100.00

data.rows[].direction string

direction within rows.

Allowed values: "inbound", "outbound"

Exampleinbound

data.rows[].currency object

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

ShowHide 3 properties

data.rows[].currency.id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.rows[].currency.code string

ISO 4217 currency code, such as SAR or USD.

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

ExampleSAR

data.rows[].currency.conversion object

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

ShowHide 3 properties

data.rows[].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.rows[].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.rows[].currency.conversion.rate string

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

Maximum length: 128 characters.

Example1.00

data.rows[].account string

account within rows.

ExampleOperating account

data.rows[].context object

context within rows.

ShowHide 3 properties

data.rows[].context.heading string

heading within context.

ExampleOperating account

data.rows[].context.subheading string

subheading within context.

ExampleOperating account

data.rows[].context.websites string[]

websites within context.

Example1 item

data.rows[].createdAt string

ISO 8601 timestamp for the authored or payment event. Recurring records preserve their scheduled occurrence.

Example2026-01-15T12:00:00.000Z

data.hasMore boolean

Whether another page is available.

Examplefalse

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

{
  "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 ↗

curl --include --fail-with-body --request GET "${NQD_API_URL:-http://api.nqd.localhost:1335}/v1/reports/movements?start=2026-01-15&end=2026-01-15" \ -H "Authorization: Bearer $NQD_API_KEY" \ -H "Workspace-Id: $NQD_WORKSPACE_ID"

{ "data": { "reportingCurrency": "Consulting services", "totals": { "inbound": "100.00", "outbound": "100.00", "net": "100.00", "missingConversion": true }, "rows": [ { "id": "01JQ2T5Y5Q3R8W9N6M4K2H7P1P", "sourceId": "01JQ2T5Y5Q3R8W9N6M4K2H7P1P", "source": { "id": "01JQ2T5Y5Q3R8W9N6M4K2H7P1P", "type": "invoice" }, "amount": "100.00", "reportingAmount": "100.00", "direction": "inbound", "currency": { "id": "01JQ2T5Y5Q3R8W9N6M4K2H7P1F", "code": "SAR", "conversion": { "from": "SAR", "to": "SAR", "rate": "1.00" } }, "account": "Operating account", "context": { "heading": "Operating account", "subheading": "Operating account", "websites": [ "https://example.com/hooks/nqd" ] }, "createdAt": "2026-01-15T12:00:00.000Z" } ], "hasMore": false } }