API Docs / Schemas / WriteOffTimeEntriesRequest

WriteOffTimeEntriesRequest

Request to write off open WIP on time entries with no bill raised. Omit the amount to write
off everything still open on each entry; give an amount to spread it across the entries
pro rata to their open WIP (each capped at its own); or give explicit allocations to say
exactly how much comes off each entry. A reason is always required.

Properties

Name Type Description
timeEntryCodes*array of string

The codes of the time entries to write off

The codes of the time entries to write off

amountnumber

Total WIP to write off across the entries. Omitted, every entry's open WIP is written off
in full. Must not exceed the entries' total open WIP.

Total WIP to write off across the entries. Omitted, every entry's open WIP is written off
in full. Must not exceed the entries' total open WIP.

allocationsarray of TimeEntryAllocationRequest

Explicit per-entry amounts (SettledValue is the write-off; BilledAmount is ignored).
When supplied, every entry in TimeEntryCodes needs one and Amount is ignored.

Explicit per-entry amounts (SettledValue is the write-off; BilledAmount is ignored).
When supplied, every entry in TimeEntryCodes needs one and Amount is ignored.

writeOffReasonCode*string

The code of the write-off reason (from the tenant's write-off reasons; must be active)

The code of the write-off reason (from the tenant's write-off reasons; must be active)

notesstring

Free-text context recorded on each allocation

Free-text context recorded on each allocation

JSON Example

{
  "timeEntryCodes": [
    "string"
  ],
  "amount": 0.01,
  "allocations": [
    {
      "timeEntryCode": "...",
      "settledValue": "...",
      "billedAmount": "..."
    }
  ],
  "writeOffReasonCode": "string",
  "notes": "string"
}

Used By Operations