Invoices
A customer invoice kept as an open item on the customer receivable account.
- API name:
financesinvoices - Domain: Finances
- Modules: Sales analytics, Finance analytics, Sales, Stores, 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 | |
| Name | label | Text | ||
| Invoice number | uid | Text | Internal number of this invoice. | |
| Invoice date | date | Date | Yes | Calendar date for this value. |
| Return | salesorderreturnId | Reference | ||
| Return | storereturnId | Reference | ||
| Sale | storepossaleId | Reference | ||
| Project | projectId | Reference | ||
| Customer | customerId | Reference | Yes | |
| Branch | customerbranchId | Reference | ||
| Contact | customercontactId | Reference | ||
| User | userId | User | ||
| Partner company | companyIdPartner | Reference | ||
| Source invoice | financesinvoiceIdSource | Reference | ||
| Customer reference | customerReference | Text | The customer's own reference for this document, such as their purchase order number. | |
| Document type | class | Constant | Yes | Invoice increases the receivable. Credit note reduces the source invoice. |
| Quote currency | currency | Constant | Yes | Currency of this invoice. The exchange rate converts amounts to the accounting currency. |
| Due date | dateDue | Date | Yes | Calendar date without time of date. |
| Amount applied | amountApplied | Currency | Yes | Part of the credit note applied to the source invoice open balance at send. Not a payment allocation. |
| Recharge amount | amountRecharge | Currency | Monetary amount in the applicable currency for this record. | |
| Exchange rate date | dateFxrateSource | Date | Calendar date of the exchange rate used for conversion. | |
| Payment term | financespaymenttermId | Reference | ||
| Exchange rate | fxrate | Decimal | Yes | Accounting-currency units for 1 unit of the other currency. Use 1 when both currencies are the same. |
| Tax in unit price | priceBasis | Constant | Yes | Whether unit prices include tax (gross) or exclude tax (net). |
| Open balance | balance | Currency | Yes | Remaining amount in document currency. |
| Discount | discount | Currency | Yes | Amount in the document or line currency. |
| Total payable | totalPayable | Currency | Yes | Monetary amount in the applicable currency for this record. |
| Rounding | rounding | Currency | Yes | Monetary amount in the applicable currency for this record. |
| Subtotal | subtotal | Currency | Yes | Sum of line amounts before tax and withholding on this document. |
| Tax | tax | Currency | Yes | Tax amount for this scope, in document currency, from the configured tax engine. |
| Withholding | withholding | Currency | Yes | Withholding tax amount, not a rate. |
| Total | total | Currency | Yes | Sum of lines at 6 decimals. Settlement and PDF use the payable total at currency minor units; any difference appears as a rounding line. |
| Credit reason | creditReason | Constant | Fixed option from the allowed set for this field. | |
| 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 | |
| Sent by | sentBy | User | ||
| Sent at | sentAt | 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 |
|---|---|---|
Return salesorderreturnId | Sales returns | reference |
Return storereturnId | Store returns | reference |
Sale storepossaleId | POS sales | reference |
Project projectId | Projects | reference |
Customer customerId | Customers | reference |
Branch customerbranchId | Customer branches | reference |
Contact customercontactId | Customer contacts | reference |
User userId | Users | reference |
Partner company companyIdPartner | Companies | reference |
Source invoice financesinvoiceIdSource | Invoices | reference |
Payment term financespaymenttermId | Payment terms | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event financesinvoices.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new invoice. | App · API · MCP · CLI |
| Edit | update | Save changes to this invoice. | App · API · MCP · CLI |
| Issue | send | Issue this invoice. The open balance and the journal entry use this action. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this invoice. | App · API · MCP · CLI |
| Revoke external links | revoke | Revoke active external share links for this invoice. | App · API · MCP · CLI |
| Share externally | share | Publish and send an external link to this document. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this invoice. 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 invoice again. | App · API · MCP · CLI |
| Archive | archive | Retire this invoice 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 invoice to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this invoice 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.
Events
Moments the record reaches on its own. Subscribe to them with a webhook.
| Name | Webhook event | Description |
|---|---|---|
| Overdue | financesinvoices.overdue | The invoice passed its due date with a balance left. |
| Followed | financesinvoices.followed | People who follow this invoice are told about it. |