Request to convert billable time entries with open WIP into client billing line items.
All entries must belong to the same client, be billable, carry an hourly rate and have WIP
left to bill. Line items are shaped by the line mode: combined (one per distinct hourly rate)
or one per entry. With no fee the entries are billed at their full billable value, as always. With
a fee, the fee is what the client is charged: it is spread across the entries pro rata to their
open WIP, and the difference between the WIP and the fee is a write-off (or write-on) that
needs a reason.
Properties
| Name | Type | Description |
|---|---|---|
| timeEntryCodes* | array of string | The codes of the time entries to bill |
The codes of the time entries to bill | ||
| vatRate | enum | Standard Reduced Zero Exempt OutOfScope |
Standard Reduced Zero Exempt OutOfScope | ||
| description | string | The invoice line description. Defaults to a summary of the billed period when omitted. |
The invoice line description. Defaults to a summary of the billed period when omitted. | ||
| billingDate | string | Target invoice date. Defaults to today when omitted. |
Target invoice date. Defaults to today when omitted. | ||
| accountingCode | string | Accounting/nominal code. Defaults from the client billing settings when omitted. |
Accounting/nominal code. Defaults from the client billing settings when omitted. | ||
| lineMode | enum | Combined PerEntry Single |
Combined PerEntry Single | ||
| feeAmount | number | The total to charge (ex VAT) for the selected entries. Omitted, the entries are billed at |
The total to charge (ex VAT) for the selected entries. Omitted, the entries are billed at | ||
| remainderHandling | enum | LeaveOpen WriteOff |
LeaveOpen WriteOff | ||
| allocations | array of TimeEntryAllocationRequest | Explicit per-entry allocations for the cherry-picking case. When supplied, every selected |
Explicit per-entry allocations for the cherry-picking case. When supplied, every selected | ||
| writeOffReasonCode | string | The code of the write-off reason. Required when the run writes time off or on; ignored |
The code of the write-off reason. Required when the run writes time off or on; ignored | ||
| notes | string | Free-text context recorded on each allocation |
Free-text context recorded on each allocation | ||
JSON Example
{
"timeEntryCodes": [
"string"
],
"vatRate": "Standard",
"description": "string",
"billingDate": "2024-01-01T00:00:00Z",
"accountingCode": "string"
}