Read workspace cash flow

GET/v1/reports/cash-flow

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

data.report object

report for this report.

ShowHide 1 property

data.report.cashflow object

cashflow within report.

ShowHide 13 properties

data.report.cashflow.currency object

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

ShowHide 4 properties

data.report.cashflow.currency.id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.report.cashflow.currency.code string

ISO 4217 currency code, such as SAR or USD.

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

ExampleSAR

data.report.cashflow.currency.conversion object

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

ShowHide 3 properties

data.report.cashflow.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.report.cashflow.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.report.cashflow.currency.conversion.rate string

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

Maximum length: 128 characters.

Example1.00

data.report.cashflow.currency.name string

Display name of the record.

ExampleSaudi Riyal

data.report.cashflow.months string[]

months within cashflow.

Example1 item

data.report.cashflow.rows object[]

rows within cashflow.

ShowHide 4 properties

data.report.cashflow.rows[].month string

month within rows.

Example2026-01

data.report.cashflow.rows[].inflow number

inflow within rows.

Example100

data.report.cashflow.rows[].outflow number

outflow within rows.

Example100

data.report.cashflow.rows[].net number

Total before tax and other modifiers.

Example100

data.report.cashflow.granularity string

granularity within cashflow.

Allowed values: "day", "month", "year"

Exampleday

data.report.cashflow.openingCash number

opening cash within cashflow.

Example100

data.report.cashflow.closingCash number

closing cash within cashflow.

Example100

data.report.cashflow.vatPaid number

vat paid within cashflow.

Example100

data.report.cashflow.vatBalance number

vat balance within cashflow.

Example100

data.report.cashflow.vatPayable number

vat payable within cashflow.

Example100

data.report.cashflow.projectedRows object[] nullable

projected rows within cashflow.

ShowHide 4 properties

data.report.cashflow.projectedRows[].month string

month within projected rows.

Example2026-01

data.report.cashflow.projectedRows[].inflow number

inflow within projected rows.

Example100

data.report.cashflow.projectedRows[].outflow number

outflow within projected rows.

Example100

data.report.cashflow.projectedRows[].net number

Total before tax and other modifiers.

Example100

data.report.cashflow.projections object[] nullable

projections within cashflow.

ShowHide 14 properties

data.report.cashflow.projections[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.report.cashflow.projections[].sourceId string

ID of the related source.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P

data.report.cashflow.projections[].kind string

kind within projections.

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

Exampleinvoice

data.report.cashflow.projections[].status string

Current status of the record or operation.

Allowed values: "scheduled", "overdue", "unavailable"

Examplescheduled

data.report.cashflow.projections[].name string

Display name of the record.

ExampleNQD record

data.report.cashflow.projections[].projectId string

Project identifier within the current workspace.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D

data.report.cashflow.projections[].partyId string

ID of the related party.

ExampleConsulting services

data.report.cashflow.projections[].materializedSourceId string nullable

ID of the related materialized source.

ExampleConsulting services

data.report.cashflow.projections[].currencyCode string

currency code within projections.

ExampleSAR

data.report.cashflow.projections[].amount number

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

Example100

data.report.cashflow.projections[].reportingAmount number

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

Example100

data.report.cashflow.projections[].context object nullable

context within projections.

ShowHide 3 properties

data.report.cashflow.projections[].context.heading string

heading within context.

ExampleOperating account

data.report.cashflow.projections[].context.subheading string

subheading within context.

ExampleOperating account

data.report.cashflow.projections[].context.websites string[]

websites within context.

Example1 item

data.report.cashflow.projections[].reason string nullable

Machine-readable reason for the validation issue.

Allowed values: "missing_value", "missing_conversion"

Examplemissing_value

data.report.cashflow.projections[].occurrenceAt string

ISO 8601 timestamp for occurrence.

Example2026-01-15T12:00:00.000Z

data.report.cashflow.projectedClosingCash number nullable

projected closing cash within cashflow.

Example100

data.report.cashflow.consolidated object

consolidated within cashflow.

ShowHide 9 properties

data.report.cashflow.consolidated.metrics object

metrics within consolidated.

ShowHide 10 properties

data.report.cashflow.consolidated.metrics.revenue number

revenue within metrics.

Example100

data.report.cashflow.consolidated.metrics.paidRevenue number

paid revenue within metrics.

Example100

data.report.cashflow.consolidated.metrics.outstandingRevenue number

outstanding revenue within metrics.

Example100

data.report.cashflow.consolidated.metrics.expenses number

expenses within metrics.

Example100

data.report.cashflow.consolidated.metrics.recurringExpenses number

recurring expenses within metrics.

Example100

data.report.cashflow.consolidated.metrics.payouts number

payouts within metrics.

Example100

data.report.cashflow.consolidated.metrics.paidPayouts number

paid payouts within metrics.

Example100

data.report.cashflow.consolidated.metrics.pendingPayouts number

pending payouts within metrics.

Example100

data.report.cashflow.consolidated.metrics.netIncome number

net income within metrics.

Example100

data.report.cashflow.consolidated.metrics.cashOnHand number

cash on hand within metrics.

Example100

data.report.cashflow.consolidated.recognizedTaxInflow number

recognized tax inflow within consolidated.

Example100

data.report.cashflow.consolidated.recognizedTaxOutflow number

recognized tax outflow within consolidated.

Example100

data.report.cashflow.consolidated.capitalizedCost number

capitalized cost within consolidated.

Example100

data.report.cashflow.consolidated.assetCarryingValue number

asset carrying value within consolidated.

Example100

data.report.cashflow.consolidated.committedResult number

committed result within consolidated.

Example100

data.report.cashflow.consolidated.cashResult number

cash result within consolidated.

Example100

data.report.cashflow.consolidated.netIncomeBeforeTax number

net income before tax within consolidated.

Example100

data.report.cashflow.consolidated.netIncomeAfterTax number

net income after tax within consolidated.

Example100

data.filters object

filters for this report.

ShowHide 2 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.fiscalStart string

fiscal start for this report.

Example2026-01-01

data.defaultRange object

default range for this report.

ShowHide 2 properties

data.defaultRange.end string

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

Example2026-01-31

data.defaultRange.start string

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

Example2026-01-01

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 ↗