v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Fiscal Documents

Get list of fiscal documents

Retrieves a paginated list of fiscal documents filtered by optional criteria.

get/fiscal-document/v1/fiscal-documents

Query parameters

pageTokenstring

Token for fetching the next page, as per cursor-based pagination.

sortstring

Example:createdAt:desc

Supported fields:

createdAt
dueDate
invoiceDate
kind
status

Supported sort modes asc:desc. If not supplied default is asc.

limitinteger

Number of results to return per page.

idsstring[]

List of IDs to filter by

sourceIdsstring[]

List of source IDs to filter by

sourceIdentifiersstring[]

List of source-specific identifiers

sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER'

Kind of the source entity

sourceKindsSourceKind[]

Filter by source kind

numberContainsstring

Filter by document number partial match

statusesFiscalDocumentStatus[]

List of fiscal document statuses to filter by

kindsFiscalDocumentKind[]

List of fiscal document kinds to filter by

originsOrigin[]

List of fiscal document origins to filter by

createdAtFromstring date-time

Creation date-time range start

createdAtTostring date-time

Creation date-time range end

invoiceDateFromstring date

Invoice date range start

invoiceDateTostring date

Invoice date range end

invoiceDatePropertyTimezoneFromstring date

Invoice date range start

invoiceDatePropertyTimezoneTostring date

Invoice date range end

dueDateFromstring date

Due date range start

dueDateTostring date

Due date range end

dueDatePropertyTimezoneFromstring date

Due date range start

dueDatePropertyTimezoneTostring date

Due date range end

amountFromnumber

Minimum document amount

amountTonumber

Maximum document amount

balanceFromnumber

Minimum document balance

balanceTonumber

Maximum document balance

hasDiscrepanciesboolean

Filter by whether the document has pending-transaction discrepancies. Reads the persisted hasDiscrepancies flag, the same one returned in the response payload.

{
  "ids": [
    "123",
    "456",
    "789"
  ],
  "sourceIds": [
    "123",
    "456",
    "789"
  ],
  "sourceIdentifiers": [
    "ABC123",
    "XYZ789"
  ],
  "statuses": [
    "OPEN",
    "COMPLETED"
  ],
  "kinds": [
    "INVOICE",
    "RECEIPT"
  ],
  "origins": [
    "MFD",
    "FISCAL_DOCUMENT"
  ]
}

Headers

X-Property-IDinteger required

Property id

Response

nextPageTokenstring

Token for fetching the next page of results