Push Vendor Deposit to Xero
POST/api/vendor-deposits/:vendorDepositId/push-to-xero
Queue a push of the vendor deposit's accounting transactions to Xero. The push runs asynchronously — a 200 response confirms the sync was queued, not that it has completed. Requires a connected Xero integration.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns 422 when the deposit cannot be pushed (e.g. no accounting transaction exists or no Xero connection is configured).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.