Payment applications
The part of a payment applied to one open customer invoice or supplier bill.
- API name:
financespaymentallocations - Domain: Finances
- Modules: Finance analytics, 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 | |
| Payment | financespaymentId | Reference | Yes | |
| Invoice | financesinvoiceId | Reference | ||
| Application date | date | Date | Yes | Calendar date for this value. |
| Bill | financesbillId | Reference | ||
| Reimbursement | employeereimbursementId | Reference | ||
| Pay slip | payrollslipId | Reference | ||
| Payment option | financesinvoicepaymentoptionId | Reference | ||
| Amount in document currency | amountDocumentCurrency | Currency | Yes | Amount applied to the open balance of the invoice or bill, in document currency. |
| Tax applied | amountDocumentCurrencyTax | Currency | Yes | Tax included in the applied document amount. |
| Amount in payment currency | amountPaymentCurrency | Currency | Yes | Part of the payment used by this application, in the treasury account currency. |
| Document amount in accounting currency | amountFunctionalDocument | Currency | Monetary amount in the applicable currency for this record. | |
| Payment amount in accounting currency | amountFunctionalPayment | Currency | Yes | Monetary amount in the applicable currency for this record. |
| Exchange gain or loss | amountFx | Signed amount | Yes | Realized gain or loss in the accounting currency. A positive amount is a gain. |
| 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
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Payment financespaymentId | Payments | owned by |
Invoice financesinvoiceId | Invoices | reference |
Bill financesbillId | Bills | reference |
Reimbursement employeereimbursementId | Employee reimbursements | reference |
Pay slip payrollslipId | Employee pay slips | reference |
Payment option financesinvoicepaymentoptionId | Customer invoice payment options | reference |
Actions
What you can do with a record. Every action also sends the webhook event financespaymentallocations.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new payment application. | App · API · MCP · CLI |
| Edit | update | Save changes to this payment application. | App · API · MCP · CLI |
| Delete | delete | Delete this payment application and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |