Receivables
The balance that one customer owes to one company in one currency.
- API name:
financesreceivables - Domain: Finances
- Modules: Sales analytics, Finance analytics, Sales, Finances
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Customer | customerId | Reference | Yes | |
| Ledger account | accountingledgeraccountId | Reference | ||
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Credit limit | creditLimit | Currency | Credit limit for this customer in this currency. Zero blocks new invoices. | |
| Available credit | creditAvailable | Signed amount | Credit limit minus the open balance. It does not go below zero. | |
| Payment term | financespaymenttermId | Reference | Payment terms for new invoices. | |
| Open balance | balance | Currency | Yes | Open invoices minus unapplied receipts, plus unapplied refunds. The unapplied amount stays on the payment. |
| Unapplied amount | unapplied | Currency | Yes | Receipt and refund amount not yet applied in this currency. It stays on payments until you allocate it. |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Customer customerId | Customers | reference |
Ledger account accountingledgeraccountId | Chart of accounts | reference |
Payment term financespaymenttermId | Payment terms | reference |
Actions
What you can do with a record. Every action also sends the webhook event financesreceivables.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new receivable. | App · API · MCP · CLI |
| Edit | update | Save changes to this receivable. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this receivable. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this receivable again. | App · API · MCP · CLI |
| Archive | archive | Retire this receivable from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this receivable to active lists and actions. | App · API · MCP · CLI |