Skip to main content

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.

Each row includes proportional_apply_enabled (the deposit's own choice, or null when it inherits), proportional_apply_effective (the value in force) and proportional_apply_source (deposit, supplier, term or global).

Approval policy: Filter with filter[awaiting_my_approval]=1. Each deposit adds approval — the approval-policy summary for this deposit: policy_enabled (false when no policy governs vendor deposits; the other fields are then null/empty), request_id, status, reason, tier_name of the latest approval request, waiting_on (names of users who can act now), can_approve_directly (whether you can approve it now; on a document with no request yet, whether its amount falls within your limit) and blocked_reason. Full timeline: GET /api/approval-requests/for/vendor_deposit/{id}. On list rows can_approve_directly for a pending request reflects whether you are among the users it is waiting on.

Request​

Responses​

OK

Response Headers
    Content-Type