Read the workspace financial center report

GET/v1/reports/center

Query parameters

timezone string

Optional timezone filter or query option.

Maximum length: 100 characters.

ExampleUTC

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

data.invoiceCounts object

invoice counts for this report.

ShowHide 2 properties

data.invoiceCounts.draft number

draft within invoice counts.

Example100

data.invoiceCounts.pending number

pending within invoice counts.

Example100

data.payoutCounts object

payout counts for this report.

ShowHide 1 property

data.payoutCounts.pending number

pending within payout counts.

Example100

data.expenseOptions object

expense options for this report.

ShowHide 11 properties

data.expenseOptions.tagOptions object[]

tag options within expense options.

ShowHide 2 properties

data.expenseOptions.tagOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.expenseOptions.tagOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.vendorOptions object[]

vendor options within expense options.

ShowHide 2 properties

data.expenseOptions.vendorOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.expenseOptions.vendorOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.clientOptions object[]

client options within expense options.

ShowHide 2 properties

data.expenseOptions.clientOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.expenseOptions.clientOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.projectOptions object[]

project options within expense options.

ShowHide 2 properties

data.expenseOptions.projectOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.expenseOptions.projectOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.projectOptionsByClient object

project options by client within expense options.

data.expenseOptions.recurringExpenseOptions object[]

recurring expense options within expense options.

ShowHide 2 properties

data.expenseOptions.recurringExpenseOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.expenseOptions.recurringExpenseOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.recurringExpenseOptionsByVendor object

recurring expense options by vendor within expense options.

data.expenseOptions.currencyOptions object[]

currency options within expense options.

ShowHide 4 properties

data.expenseOptions.currencyOptions[].id string

Opaque identifier for this resource or reference.

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

ExampleConsulting services

data.expenseOptions.currencyOptions[].code string

Stable machine-readable error or resource code.

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

ExampleConsulting services

data.expenseOptions.currencyOptions[].conversion object

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

ShowHide 3 properties

data.expenseOptions.currencyOptions[].conversion.from string

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

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

ExampleSAR

data.expenseOptions.currencyOptions[].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.expenseOptions.currencyOptions[].conversion.rate string

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

Maximum length: 128 characters.

Example1.00

data.expenseOptions.currencyOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.modifierOptions object[]

modifier options within expense options.

ShowHide 7 properties

data.expenseOptions.modifierOptions[].id string

Opaque identifier for this resource or reference.

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

ExampleConsulting services

data.expenseOptions.modifierOptions[].appliedId string nullable

Stable identity of this saved modifier application. Preserve it when updating a financial record, including repeated uses of the same catalog modifier.

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

ExampleConsulting services

data.expenseOptions.modifierOptions[].name string

Display name of the record.

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

ExampleNQD record

data.expenseOptions.modifierOptions[].description string nullable

Optional human-readable description of the record.

Maximum length: 10000 characters.

ExampleConsulting services for January 2026

data.expenseOptions.modifierOptions[].entryIndex number nullable

entry index within modifier options.

Example100

data.expenseOptions.modifierOptions[].value string

Value returned by the operation.

Maximum length: 128 characters.

Example100.00

data.expenseOptions.modifierOptions[].currency object

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

ShowHide 3 properties

data.expenseOptions.modifierOptions[].currency.id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.expenseOptions.modifierOptions[].currency.code string

ISO 4217 currency code, such as SAR or USD.

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

ExampleSAR

data.expenseOptions.modifierOptions[].currency.conversion object

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

ShowHide 3 properties

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

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

Maximum length: 128 characters.

Example1.00

data.expenseOptions.bankAccountOptions object[]

bank account options within expense options.

ShowHide 3 properties

data.expenseOptions.bankAccountOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.expenseOptions.bankAccountOptions[].name string

Display name of the record.

ExampleNQD record

data.expenseOptions.bankAccountOptions[].archived boolean nullable

archived within bank account options.

Exampletrue

data.expenseOptions.defaultCurrencyId string

ID of the related default currency.

Examplenull

data.incomeOptions object

income options for this report.

ShowHide 7 properties

data.incomeOptions.defaultCurrencyId string

ID of the related default currency.

Examplenull

data.incomeOptions.accountOptions object[]

account options within income options.

ShowHide 3 properties

data.incomeOptions.accountOptions[].archived boolean

archived within account options.

Exampletrue

data.incomeOptions.accountOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.incomeOptions.accountOptions[].name string

Display name of the record.

ExampleNQD record

data.incomeOptions.currencyOptions object[]

currency options within income options.

ShowHide 4 properties

data.incomeOptions.currencyOptions[].id string

Opaque identifier for this resource or reference.

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

ExampleConsulting services

data.incomeOptions.currencyOptions[].code string

Stable machine-readable error or resource code.

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

ExampleConsulting services

data.incomeOptions.currencyOptions[].conversion object

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

ShowHide 3 properties

data.incomeOptions.currencyOptions[].conversion.from string

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

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

ExampleSAR

data.incomeOptions.currencyOptions[].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.incomeOptions.currencyOptions[].conversion.rate string

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

Maximum length: 128 characters.

Example1.00

data.incomeOptions.currencyOptions[].name string

Display name of the record.

ExampleNQD record

data.incomeOptions.clientOptions object[]

client options within income options.

ShowHide 2 properties

data.incomeOptions.clientOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.incomeOptions.clientOptions[].name string

Display name of the record.

ExampleNQD record

data.incomeOptions.projectOptions object[]

project options within income options.

ShowHide 3 properties

data.incomeOptions.projectOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.incomeOptions.projectOptions[].clientId string

Optional client reference. Null means the current workspace owns the record; do not create a placeholder client.

Examplenull

data.incomeOptions.projectOptions[].name string

Display name of the record.

ExampleNQD record

data.incomeOptions.contactOptions object[]

contact options within income options.

ShowHide 3 properties

data.incomeOptions.contactOptions[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.incomeOptions.contactOptions[].clientId string

Optional client reference. Null means the current workspace owns the record; do not create a placeholder client.

Examplenull

data.incomeOptions.contactOptions[].name string

Display name of the record.

ExampleNQD record

data.incomeOptions.tagOptions string[]

tag options within income options.

Example1 item

data.currencies object[]

currencies for this report.

ShowHide 4 properties

data.currencies[].id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.currencies[].code string

Stable machine-readable error or resource code.

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

ExampleSAR

data.currencies[].conversion object

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

ShowHide 3 properties

data.currencies[].conversion.from string

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

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

ExampleSAR

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

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

Maximum length: 128 characters.

Example1.00

data.currencies[].name string

Display name of the record.

ExampleSaudi Riyal

data.modifiers object[]

Modifiers applied to one entry or the whole source. Supported values are signed fixed amounts or percentages, such as `15.00%` or `-25.00`; arbitrary multiplication and division are not supported.

ShowHide 7 properties

data.modifiers[].id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1J

data.modifiers[].appliedId string nullable

Stable identity of this saved modifier application. Preserve it when updating a financial record, including repeated uses of the same catalog modifier.

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

ExampleConsulting services

data.modifiers[].name string

Display name of the record.

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

ExampleVAT

data.modifiers[].description string nullable

Optional human-readable description of the record.

Maximum length: 10000 characters.

ExampleValue added tax

data.modifiers[].entryIndex number nullable

entry index within modifiers.

Example100

data.modifiers[].value string

Modifier value. A trailing `%` marks a percentage; a leading `-` marks a decrease. Modifiers support fixed or percentage adjustments, not arbitrary multiplication or division.

Maximum length: 128 characters.

Example15.00%

data.modifiers[].currency object

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

ShowHide 3 properties

data.modifiers[].currency.id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.modifiers[].currency.code string

ISO 4217 currency code, such as SAR or USD.

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

ExampleSAR

data.modifiers[].currency.conversion object

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

ShowHide 3 properties

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

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

Maximum length: 128 characters.

Example1.00

data.taxModifierId string

Identifier of the workspace payable modifier used to calculate VAT. Apply the matching modifier in the flat modifiers array.

Example100.00

data.templates object[]

templates for this report.

ShowHide 8 properties

data.templates[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1H

data.templates[].name string

Display name of the record.

ExampleNQD record

data.templates[].description string

Optional human-readable description of the record.

ExampleConsulting services for January 2026

data.templates[].unitCode string

Unit code from the workspace catalog.

Examplehour

data.templates[].quantity string

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

Maximum length: 128 characters.

Example2.00

data.templates[].pricePerUnit string

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

Maximum length: 128 characters.

Example100.00

data.templates[].currencyId string

Currency identifier for the amount. It selects the currency metadata used by the record.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.templates[].modifierIds string[] nullable

Ordered modifier identifiers applied to the record.

at most 1000 items

Example1 item

data.workspaceInfo object

workspace info for this report.

ShowHide 4 properties

data.workspaceInfo.id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

data.workspaceInfo.name string

Display name of the record.

ExampleNQD record

data.workspaceInfo.email string

Email address associated with the identity.

Exampleowner@example.com

data.workspaceInfo.phone string

phone within workspace info.

Example+966500000000

data.payoutInvoices object

payout invoices for this report.

ShowHide 3 properties

data.payoutInvoices.options object[]

options within payout invoices.

ShowHide 2 properties

data.payoutInvoices.options[].id string

Opaque identifier for this resource or reference.

ExampleConsulting services

data.payoutInvoices.options[].name string

Display name of the record.

ExampleNQD record

data.payoutInvoices.optionsByProject object

options by project within payout invoices.

data.payoutInvoices.optionsByClient object

options by client within payout invoices.

data.reportingCurrency object

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

ShowHide 4 properties

data.reportingCurrency.id string

Opaque identifier for this resource or reference.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data.reportingCurrency.code string

Stable machine-readable error or resource code.

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

ExampleConsulting services

data.reportingCurrency.conversion object

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

ShowHide 3 properties

data.reportingCurrency.conversion.from string

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

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

ExampleSAR

data.reportingCurrency.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.reportingCurrency.conversion.rate string

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

Maximum length: 128 characters.

Example1.00

data.reportingCurrency.name string

Display name of the record.

ExampleNQD record

data.invoiceQueue object[]

invoice queue for this report.

ShowHide 4 properties

data.invoiceQueue[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P

data.invoiceQueue[].name string

Display name of the record.

ExampleNQD record

data.invoiceQueue[].shortId string

ID of the related short.

ExampleINV-0001

data.invoiceQueue[].pendedAt string

ISO 8601 timestamp for pended.

Examplenull

data.payoutQueue object[]

payout queue for this report.

ShowHide 3 properties

data.payoutQueue[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1T

data.payoutQueue[].projectId string

Project identifier within the current workspace.

Examplenull

data.payoutQueue[].pendedAt string

ISO 8601 timestamp for pended.

Examplenull

data.cash object

cash for this report.

ShowHide 2 properties

data.cash.inbound number

inbound within cash.

Example100

data.cash.outbound number

outbound within cash.

Example100

data.stats object

stats for this report.

ShowHide 15 properties

data.stats.overdueInvoices number

overdue invoices within stats.

Example100

data.stats.outstandingInvoices number

outstanding invoices within stats.

Example100

data.stats.outstandingPayouts number

outstanding payouts within stats.

Example100

data.stats.transactionsThisMonth number

transactions this month within stats.

Example100

data.stats.incomeThisMonth number

income this month within stats.

Example100

data.stats.expensesThisMonth number

expenses this month within stats.

Example100

data.stats.activeClients number

active clients within stats.

Example100

data.stats.activeProjects number

active projects within stats.

Example100

data.stats.activeVendors number

active vendors within stats.

Example100

data.stats.activeContacts number

active contacts within stats.

Example100

data.stats.activeEntries number

active entries within stats.

Example100

data.stats.assets number

assets within stats.

Example100

data.stats.recurringInvoices number

recurring invoices within stats.

Example100

data.stats.recurringExpenses number

recurring expenses within stats.

Example100

data.stats.recurringPayouts number

recurring payouts within stats.

Example100

data.monthStart string

month start for this report.

ExampleConsulting services

data.monthEnd string

month end for this report.

ExampleConsulting services

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 ↗