Sign in

v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB
Clients

Update Client

Update an existing client. Only the fields supplied in the body are modified.

put/clients/{client_id}

Path parameters

client_idnumber required
Example:107

Client ID

Request body

namestring
projectsstring[]

Project encoded IDs to assign to the client.

lineItemMaskstring

Template for generated invoice line-item names.

defaultDiscountnumber

Default discount rate as a percentage (0-100).

paymentDueDaysinteger

Default invoice payment term in days (0-365).

referencestring
invoicePublicNotesstring
businessDetailsstring
excludedLabelsstring[]

Labels excluded from invoicing (max 8).

emailstring[]

Invoice recipient email addresses (max 10).

status'active' | 'archived' | 'deleted'

Client status (update only).

Example request

{
  "name": "Client Name"
}

Response

OK

idnumber required
namestring required
projectsstring[] required

List of projects ID

businessDetailsstring nullable

Example response

{
  "id": 4567,
  "name": "Client Name",
  "projects": [
    "ev:1234567890"
  ],
  "budget": {
    "type": "money",
    "budget": 100000,
    "period": "general"
  }
}