API Docs / Schemas / BillClientsTimeRequest

BillClientsTimeRequest

Request to bill several clients' unbilled time in one run — the whole-book equivalent of
billing a single client's hand-picked entries. The server resolves which entries to bill
from the same window and team member filters the unbilled list was viewed under, so the
caller doesn't have to enumerate entry codes for every client.
Entries with no hourly rate cannot be billed and are skipped rather than failing the run.
There is no VAT rate to pass: each client is billed at its own treatment, so a run
covering a mix of UK and outside-the-scope clients still invoices each of them correctly.

Properties

Name Type Description
clientCodes*array of string

The codes of the clients whose unbilled time should be billed

The codes of the clients whose unbilled time should be billed

fromDatestring

Only bill entries on or after this date. Unbounded when omitted.

Only bill entries on or after this date. Unbounded when omitted.

toDatestring

Only bill entries on or before this date. Unbounded when omitted.

Only bill entries on or before this date. Unbounded when omitted.

userCodestring

Only bill entries recorded by this team member. All team members when omitted.

Only bill entries recorded by this team member. All team members when omitted.

descriptionstring

The invoice line description. Defaults to a summary of each client's billed period when omitted.

The invoice line description. Defaults to a summary of each client's billed period when omitted.

billingDatestring

Target invoice date. Defaults to today when omitted.

Target invoice date. Defaults to today when omitted.

accountingCodestring

Accounting/nominal code. Defaults from the client billing settings when omitted.

Accounting/nominal code. Defaults from the client billing settings when omitted.

lineModeenum

Combined PerEntry

Combined PerEntry

JSON Example

{
  "clientCodes": [
    "string"
  ],
  "fromDate": "2024-01-01",
  "toDate": "2024-01-01",
  "userCode": "string",
  "description": "string"
}

Used By Operations