Send Remittance Advice
POST/api/vendor-deposits/:vendorDepositId/send-remittance
Email a remittance advice for a paid vendor deposit to the supplier.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Sends a supplier-facing email containing the deposit reference, PO number, supplier reference (PI #), amount paid, payment date and payment reference — bank/account numbers are never included. Selected deposit attachments (e.g. the wire confirmation uploaded with category payment_proof) are attached to the email. Stamps remittance_sent_at on the deposit and returns the full updated deposit resource.
Validation (SendVendorDepositRemittanceRequest):
to(required, email) — recipient, usually the supplier's emailcc(optional, array of emails)subject(required, string, max 255)note(optional, string, max 2000) — included in the email bodyattachment_ids(optional, array of integers) — must belong to this deposit, else 422
Errors (422): deposit not yet paid (allowed statuses: partially_paid, paid, partially_applied, fully_applied); attachment ids not belonging to the deposit; validation failures.
- attachment file missing from storage → 422 before anything is sent.
Delivery is synchronous: the request returns only after the mail transport has accepted the message, and remittance_sent_at is stamped only then (remittance_status = sent; any earlier failure is cleared). If the transport rejects it (or an attachment cannot be read), remittance_sent_at is not updated and the response is a 422 whose error explains why — the failure is also recorded on the document as remittance_status = failed with remittance_failed_at and the transport's reason in remittance_error, and stays there until a later send succeeds. remittance_sent_at always holds the last successful delivery, so read remittance_status to know how the newest send went. Correct the problem and send again.
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.