List Vendor Deposits

GET 
/api/vendor-deposits

Paginated list of vendor deposits. Supports Spatie QueryBuilder filters and sorting.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Note: bank details are omitted from list responses — payee_bank_details and supplier.wire_instructions are only returned by detail-type endpoints (show, action responses).

Each deposit includes attachments_count (number of attached documents) and attachment_filenames (their file names). Sortable by attachments_count. Filter with filter[attachments_count] (e.g. filter[attachments_count.is]=0 for deposits with no documents) or filter[attachment_filename] to match an attached document's file name.

Third-party references: filter[related_purchase_order_id] returns deposits that reference the given purchase order as a third-party association; the advanced filter column related_purchase_order_number and free-text search also match the referenced PO number.

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.