Bills
A supplier invoice awaiting payment, kept as an open item on the supplier payable account.
- API name:
financesbills - Domain: Finances
- Modules: Finance analytics, Purchasing analytics, 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 | ||
| Bill number | uid | Text | Internal number of this bill. This is not the supplier invoice number. | |
| Bill date | date | Date | Yes | Calendar date for this value. |
| Return | purchaseorderreturnId | Reference | ||
| Project | projectId | Reference | ||
| Supplier | supplierId | Reference | Yes | |
| Contact | suppliercontactId | Reference | ||
| Bank account | supplierbankaccountId | Reference | ||
| User | userId | User | ||
| Source bill | financesbillIdSource | Reference | ||
| Supplier invoice number | supplierReference | Text | The supplier's invoice number. It must be unique for this supplier while the bill is active. | |
| Document type | class | Constant | Yes | Bill increases the payable. Credit note reduces the source bill. |
| Quote currency | currency | Constant | Yes | Currency of this bill. 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 bill open balance at approve. Not a payment allocation. |
| Exchange rate date | dateFxrateSource | Date | Calendar date of the exchange rate used for conversion. | |
| Incoterm | incoterm | Constant | Fixed option from the allowed set for this field. | |
| 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. | |
| Hold reason | holdReason | 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 | |
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Held by | heldBy | User | ||
| Held at | heldAt | 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 purchaseorderreturnId | Purchase returns | reference |
Project projectId | Projects | reference |
Supplier supplierId | Suppliers | reference |
Contact suppliercontactId | Supplier contacts | reference |
Bank account supplierbankaccountId | Supplier bank accounts | reference |
User userId | Users | reference |
Source bill financesbillIdSource | Bills | 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 financesbills.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new bill. | App · API · MCP · CLI |
| Edit | update | Save changes to this bill. | App · API · MCP · CLI |
| Approve | approve | Approve this bill for payment. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this bill. | App · API · MCP · CLI |
| Hold | hold | Puts the bill on payment hold so it is not paid until resumed. | App · API · MCP · CLI |
| Resume | unhold | Clear the payment hold and return the bill to its normal workflow. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this bill. 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 bill again. | App · API · MCP · CLI |
| Archive | archive | Retire this bill 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 bill to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this bill 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 | financesbills.overdue | The bill passed its due date with a balance left. |