Payments
Money received from a customer or paid to a supplier, applied against documents and treasury accounts.
- API name:
financespayments - Domain: Finances
- Modules: Sales analytics, Finance analytics, Purchasing analytics, Sales, Finances, Purchasing
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| Payment number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Payment date | date | Date | Yes | Date used for the exchange rate. |
| Order | salesorderId | Reference | ||
| Customer | customerId | Reference | ||
| Supplier | supplierId | Reference | ||
| User | userId | User | ||
| Treasury account | treasuryaccountId | Reference | Yes | |
| Ledger account | accountingledgeraccountId | Reference | ||
| Cost center | accountingcostcenterId | Reference | ||
| Party | party | Constant | Value from the table catalog for this field. | |
| Employee | employeeId | Reference | ||
| Tax registration | taxregistrationId | Reference | ||
| Type | direction | Constant | Yes | Whether money comes in (receipt) or goes out (payment). |
| Category | category | Option (Select) | ||
| Payment method | method | Constant | Yes | Fixed option from the allowed set for this field. |
| Amount | amount | Currency | Yes | Amount in the treasury account currency. |
| Reference | reference | Text | ||
| Unapplied amount | unapplied | Currency | Yes | Payment amount that is not applied yet. It stays on this payment for a later allocation. |
| Cancel reason | cancelReason | Text Area | Required explanation when canceling this record. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Order salesorderId | Sales orders | reference |
User userId | Users | reference |
Treasury account treasuryaccountId | Treasury accounts | reference |
Ledger account accountingledgeraccountId | Chart of accounts | reference |
Cost center accountingcostcenterId | Cost centers | reference |
Tax registration taxregistrationId | Tax registrations | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event financespayments.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new payment. | App · API · MCP · CLI |
| Edit | update | Save changes to this payment. | App · API · MCP · CLI |
| Record | process | Record this payment in the treasury account. You cannot edit it after processing. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this payment. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this payment. 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 payment again. | App · API · MCP · CLI |
| Archive | archive | Retire this payment 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 payment to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this payment and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.