Employee reimbursements
An employee's request to be repaid for a business expense they paid, with supporting receipts.
- API name:
employeereimbursements - Domain: Employment
- Modules: Human resources, My workspace
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Employee | employeeId | Reference | Yes | |
| Name | label | Text | ||
| Number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| User | userId | User | ||
| Bank account | employeebankaccountId | Reference | ||
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Open balance | balance | Currency | Yes | |
| 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. |
| Total | total | Currency | Yes | Document total after discounts, tax, and withholding in document currency. |
| 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 | |
| Submitted by | submittedBy | User | ||
| Submitted at | submittedAt | Date and Time | ||
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Rejected by | rejectedBy | User | ||
| Rejected at | rejectedAt | 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 |
|---|---|---|
Employee employeeId | Employees | grouped by |
User userId | Users | reference |
Bank account employeebankaccountId | Employee bank accounts | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event employeereimbursements.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new reimbursement. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this reimbursement. | App · WebMCP · API · MCP · CLI |
| Submit reimbursement | submit | Sends the reimbursement to HR for review. | App · API · MCP · CLI |
| Cancel submission | unsubmit | Withdraws a submitted reimbursement that is not yet approved. | App · API · MCP · CLI |
| Approve | approve | Approve this reimbursement so the next step can run. | App · WebMCP · API · MCP · CLI |
| Reject | reject | Reject this reimbursement. | App · WebMCP · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this reimbursement. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this reimbursement. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this reimbursement again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this reimbursement from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this reimbursement to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this reimbursement and the data that belongs with it. This cannot be undone. | App · WebMCP · 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 |
|---|---|---|
| Unpaid reimbursement | employeereimbursements.unpaid | The approved reimbursement still has an unpaid balance. |