Vendor Deposits
List Vendor Deposits
Paginated list of vendor deposits. Supports Spatie QueryBuilder filters and sorting.
Create Vendor Deposit
Create a new vendor deposit. Returns 201 with the created deposit.
Get Vendor Deposit
Retrieve a single vendor deposit with its relations (supplier, purchase order, payments, applications, refunds).
Update Vendor Deposit
Update a vendor deposit. All fields are optional (`sometimes`).
Delete Vendor Deposit
Delete a vendor deposit. Any active applications of the deposit are unapplied first, so each linked purchase invoice has its deposits-applied totals and payment status recalculated. Returns 204 No Content.
Payment Request Routing Preview
Preview where a payment request would route before submitting. Drives the 'Payment request will be sent to …' indicator in the Record Proforma Invoice drawer and the draft-deposit hint.
Submit Vendor Deposit for Approval
Submit a draft deposit for payment approval.
Approve Vendor Deposit
Approve a pending deposit.
Approve Vendor Deposit (Without Payment)
Approve a deposit without recording a payment. Status becomes APPROVED; amount_paid is unchanged. Use this when payment will be recorded later via /payments.
Reject Vendor Deposit
Reject a pending deposit with an optional reason.
Cancel Vendor Deposit
Cancel a vendor deposit.
Write Off Vendor Deposit
Write off the remaining balance of a deposit with an optional reason.
Duplicate Vendor Deposit
Duplicate an existing deposit. Returns 201 with the new deposit.
Void Vendor Deposit
Void a vendor deposit with an optional reason. Voiding reverses the deposit's accounting impact and removes it from open-liability reporting. Deposits with applied or refunded amounts cannot be voided.
Revert Vendor Deposit to Draft
Revert a submitted or approved vendor deposit back to draft with an optional reason. Any pending approval chain is discarded so a resubmission rebuilds it from scratch.
Link Vendor Deposit to Purchase Order
Link a vendor deposit to a purchase order, or unlink it by passing null. The purchase order must belong to the same supplier as the deposit, and the deposit must not already have a third-party purchase order reference (unlink it first).
Link Vendor Deposit to Third-Party Purchase Order
Link a vendor deposit to a purchase order owned by a DIFFERENT supplier as a third-party reference, or unlink it by passing null. Use this for freight, duty, or inspection prepayments (e.g. DDP freight paid to a forwarder against the goods supplier's PO).
List Vendor Deposit Approval Steps
List the approval chain for a vendor deposit, ordered by level. Each step records its approval level, assigned approver, status (pending, approved, or rejected), and who actioned it.
Approve Vendor Deposit Approval Step
Approve the next pending approval step on a vendor deposit, with optional notes (max 1000 characters). Only the step's assigned approver may action it. When the final step is approved the deposit transitions to approved.
Reject Vendor Deposit Approval Step
Reject the deposit at the next pending approval step, with optional notes (max 1000 characters). Only the step's assigned approver may action it. Rejection transitions the deposit back to draft.
Record Payment
Record a payment against a vendor deposit (full or partial), with the payment date, currency rate, and optional reference.
Refund Deposit
Refund an amount from a vendor deposit. Validated by RefundVendorDepositRequest.
Send Remittance Advice
Email a remittance advice for a paid vendor deposit to the supplier.
Scan Payment Proof (OCR)
OCR a payment-proof image/PDF (a wire confirmation or receipt) and return the extracted payment fields for the payer to review before recording the payment.
Apply To Purchase Invoices
Apply a paid deposit's unapplied balance to one or more purchase invoices (bills) of the same supplier.
Unapply Deposit Application
Unapply (reverse) a previously applied deposit application. Returns 204 No Content.
Preview Vendor Deposit Application
Preview the effect of applying a deposit amount to a purchase invoice (bill) without committing anything. Returns the before/after balances on both the deposit and the bill, the tenant-currency amount, and any FX gain/loss that would be posted when the deposit and bill currencies differ.
List Applicable Bills for Vendor Deposit
List open purchase invoices (bills) from the deposit's supplier that the deposit can be applied to, including each bill's outstanding balance after payments and previously applied deposits. Returns up to 100 bills.
Get Vendor Deposit Accounting Transactions
Get the accounting transactions posted for a vendor deposit. The primary vendor-deposit-paid transaction is returned in data (null when none exists yet); application, refund, and write-off transactions are returned in related_transactions.
Generate Vendor Deposit Accounting Transaction
Generate (or regenerate) the accounting transactions for a vendor deposit from its current payments, applications, refunds, and write-offs. No request body is required.
Push Vendor Deposit to QuickBooks Online
Queue a push of the vendor deposit's accounting transactions to QuickBooks Online. The push runs asynchronously — a 200 response confirms the sync was queued, not that it has completed. Requires a connected QuickBooks Online integration.
Push Vendor Deposit 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.
List Vendor Deposit Attachments
List all attachments on a vendor deposit.
Upload Vendor Deposit Attachment
Upload an attachment (multipart/form-data). Max size 10 MB. Optional description (<=500 chars).
Download Vendor Deposit Attachment
Download the original attachment file.
Delete Vendor Deposit Attachment
Delete an attachment. Returns 204 No Content.
Get Vendor Deposit Aging Report
Aging report bucketed by current / 1-30 / 31-60 / 61-90 / over_90 days. Returns totals and deposit details per bucket.
Get Vendor Deposit Summary Stats
Aggregate KPI stats across all deposits (totals by status, available balance, etc.).
Supplier Statement
All deposits for a specific supplier with totals (amount, paid, applied, refunded, available).
Get Vendor Deposit Activity Log
Paginated activity log (Spatie Activitylog) for a vendor deposit.
Get Vendor Deposit Write-Off Report
Report of written-off vendor deposits, with per-deposit rows, totals, and a per-supplier breakdown sorted by written-off amount.
Get Cash Due Schedule
Cash due schedule for deposit obligations, combining existing deposits and projected payment-term milestones on open purchase orders. Rows are grouped into sections: due_now (triggered and due or overdue), due_within_30_days, upcoming_by_trigger (dated but trigger not yet reached), undated, late_shipments, and shortfalls.
Get Cash Flow Forecast
Forecast of upcoming cash outflows from unpaid deposit obligations, bucketed by day, week, or month. Buckets include existing deposits and projected payment-term milestones on open purchase orders, keyed by due date.
Get Upcoming Liability Report
Upcoming deposit liabilities: every outstanding deposit obligation (existing deposits plus projected payment-term milestones on open purchase orders), sorted with overdue and ready-to-pay rows first. Rows with no due date are returned separately in undated_rows.
Get Supplier Exposure Report
Deposit exposure grouped by supplier, sorted by outstanding amount. Each supplier row aggregates its outstanding obligations (existing deposits plus projected milestones), overdue and near-term amounts, unapplied paid balances, pending approvals, and coverage shortfalls/overages, and includes the underlying obligation_rows, shortfall_rows, and a per-purchase-order breakdown.
Get Exceptions Queue
Deposit obligations that need attention, grouped into sections: overdue, due_soon (next 7 days), blocked (trigger event not yet reached), pending_approval, unapplied_after_bill (paid deposits still unapplied after a supplier bill has arrived), late_shipments, and shortfalls. The summary aggregates counts and tenant-currency amounts per section.
Get Purchase Orders by Shipping Stage
Open purchase orders with deposit schedules, grouped by their farthest-reached installment trigger stage (e.g. PO approved, shipped, received). Each stage lists its purchase orders with the outstanding deposit amount still owed, so you can see how much cash is committed at each stage of the inbound pipeline.
List Expected Deposit Milestones
List expected deposit milestones derived from the payment-term schedules of draft and open purchase orders. Each milestone describes an installment: its trigger event, expected amount, due date, and lifecycle status — expected (trigger not reached), ready_to_create (trigger reached, no deposit yet), created (linked to a deposit), or out_of_sync (linked deposit no longer matches the schedule).
Bulk Archive Vendor Deposits
Archive multiple deposits by id.
Bulk Unarchive Vendor Deposits
Unarchive multiple deposits by id.
Bulk Delete Vendor Deposits
Hard-delete multiple deposits by id. Any active applications of each deposit are unapplied first, so each linked purchase invoice has its deposits-applied totals and payment status recalculated. Returns a message with the delete count.
Bulk Create Vendor Deposits
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`).
Bulk Apply Vendor Deposits
Apply multiple deposits to purchase invoices (bills) in one operation. Each item names a deposit, a bill, and the amount to apply in the deposit's currency.
Bulk Approve Vendor Deposits
Approve multiple vendor deposits in one operation. Deposit IDs must be unique and refer to existing deposits.
Preview Vendor Deposit Import
Preview a CSV import of vendor deposits before running it. References a previously uploaded CSV file by its stored name and returns the parsed records, the detected file headers, the list of importable fields, and any unmapped (difference) or missing required (required_difference) fields so the column mapping can be corrected before importing.
Import Vendor Deposits
Import vendor deposits from a previously uploaded CSV file using the supplied column mapping. If required fields are missing from the mapping, the endpoint returns the same preview payload as the preview endpoint instead of importing.