List documents

get

https://api.open-finance.ai/integrations/{integrationId}/documents

Sales documents (invoices, receipts, credit notes, proformas and more) of an invoicing system or Priority, deleted ones left out. Amounts are integers in minor units (agorot for ILS). An integration whose connector does not sync this stream answers an empty page with freshness.dataAsOf null, not an error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integrationId

string

required

^intg_[0-9A-HJKMNP-TV-Z]{26}$

The integration's id (intg_ and 26 characters), from GET /integrations/.

Query Params

status

string

enum

Only documents in this status.

type

string

enum

Only documents of this type.

counterpartyId

string

^icus_[0-9A-HJKMNP-TV-Z]{26}$

Only documents of this customer (icus_ id).

issuedFrom

date

Issued on or after. YYYY-MM-DD.

issuedTo

date

Issued on or before. YYYY-MM-DD.

receivableOnly

boolean

Only documents that are receivable. true or false.

number

string

length between 1 and 64

The document number, matched exactly (1–64 characters).

limit

integer

1 to 200

Defaults to 50

Items per page, 1–200. Default 50.

cursor

string

length between 1 and 2048

nextCursor from the previous page. It is valid only for the same integration and listing; anything else answers 400 CURSOR_INVALID.

Responses

401

Missing or invalid access token (answered by the API gateway, without the error envelope).

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response

400The request is invalid. type: VALIDATION_FAILED, CURSOR_INVALID.

403Refused. type: INSUFFICIENT_SCOPE, FORBIDDEN, IP_NOT_ALLOWED, NOT_AVAILABLE_ON_SURFACE, FORBIDDEN_BY_POLICY, USER_ID_REQUIRED, UPGRADE_REQUIRED, ENTITLEMENT_NOT_PROVISIONED, NOT_ENTITLED.

404Not found. type: NOT_FOUND, INTEGRATION_NOT_FOUND. A malformed id in the path is also NOT_FOUND.

409Conflict. type: ACCOUNT_TERMINATION_PENDING.

429Too many requests. type: RATE_LIMITED. At most 600 requests per minute per API client (all user ids of the key together); wait as Retry-After says.

500Internal error. type: INTERNAL.

503Temporarily unavailable. type: TEMPORARILY_UNAVAILABLE, CONNECTOR_UNAVAILABLE.