Skip to main content
POST
Create Client

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required
Example:

"Client Name"

projects
string[]

Project encoded IDs to assign to the client.

lineItemMask
string

Template for generated invoice line-item names.

defaultTax
object

Default tax for the client's invoices.

defaultDiscount
number

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

paymentDueDays
integer

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

reference
string
invoicePublicNotes
string
businessDetails
string
billingDetails
object

Client billing details (all fields optional).

excludedLabels
string[]

Labels excluded from invoicing (max 8).

email
string[]

Invoice recipient email addresses (max 10).

Response

Created

id
number
required
Example:

4567

name
string
required
Example:

"Client Name"

projects
string[]
required

List of projects ID

Example:
businessDetails
string | null
budget
object