Skip to main content

Bulk Create Vendor Deposits

POST 
/api/vendor-deposits/bulk-create

Create multiple vendor deposits in one call — one per item, each linked to a purchase order. Shared header fields (deposit_date, due_date, external_reference, notes, proportional_apply_enabled) apply to every deposit created. proportional_apply_enabled is boolean or null: null (or omitted) lets each deposit inherit — its supplier's proportional_apply_deposits when set, else on when its purchase order's payment term has a payment schedule, else the account setting vendor_deposits_proportional_apply_enabled; true / false set an explicit choice on every deposit created. Each returned deposit carries the resolved proportional_apply_effective and its proportional_apply_source (deposit, supplier, term, global).

Required scope: accounting:write

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

Item fields: purchase_order_id (required), currency_id, currency_rate, currency_id_tenant_snapshot, amount, and amount_in_tenant_currency are required; supplier_id, tax_amount, tax_amount_in_tenant_currency, tax_lines, payment_term_schedule_line_index, inbound_shipment_id, payment_term_schedule_snapshot, and is_ownership_transfer are optional.

Returns 201 with the created deposits.

Approval policy: While the purchase-order approval policy is enabled, a deposit cannot be linked to a purchase order that is not yet approved or whose changes await re-approval (422 approval_required / approval_pending).

Request​

Responses​

Created

Response Headers
    Content-Type