Export Vendor Deposits
GET/api/export/v2/vendor-deposits
Streams all vendor deposits matching the given filters as a CSV file download (vendor-deposits.csv). Honors the same filters and sorting as the vendor deposit list endpoints.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
CSV columns: Deposit #, Supplier, Purchase Order, Status, Currency, Amount, Amount Paid, Amount Applied, Amount Refunded, Available Balance, Deposit Date, Due Date, External Reference, Notes, Created At. Available Balance is computed as amount paid minus amounts applied and refunded (floored at 0).
Archived deposits are excluded by default; pass filter[archived]=1 to include them. The response is a file download (text/csv), not JSON.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
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.