Customers

Manage customer billing and shipping information for invoices and estimates.

Create Customer

POST https://api.invoiless.com/v1/customers

Create a new customer with billing and shipping information.

Example:

{
  "billTo": {
    "company": "Invoiless",
    "email": "customer@example.com",
    "phone": "202-555-0113",
    "address": "4320 Ryder Avenue"
  }
}

Body Parameters

Name	Type	Description	Required
billTo	object	Bill to address	Yes
shipTo	object	Ship to address	No
tax	object	Tax identifier with a custom name (e.g. VAT ID, Tax Number, GST Number)	No
registration	object	Legal/company registration identifier (e.g. KVK, Handelsregister, SIREN)	No
reference	string	Buyer reference for internal routing, e.g. the Leitweg-ID for German B2G invoices (max 100 characters)	No
peppol	object	Buyer Peppol electronic address	No
cc	array[string]	Cc email recipients (max 3, unique, cannot duplicate billTo.email or bcc emails)	No
bcc	array[string]	Bcc email recipients (max 3, unique, cannot duplicate billTo.email or cc emails)	No
currency	string	ISO 4217 currency code	No
lang	string	Customer language, possible values are en, fr, de, nl, es, bg, ro, ja, mn, da, sv, lt, fi, hu, cs, it, et, lv, pt, pl, sk, or zh	No
dateFormat	string	Date format, possible values are DD/MM/YYYY, MM/DD/YYYY, YYYY/MM/DD, or YYYY/DD/MM, with 3 possible separators: /, -, or .	No
attachPdf	bool	Attach PDF copy to emails	No
notes	string	Private notes (max 1000 characters)	No
tags	array[string]	Customer tags (max 10 tags, each max 50 characters)	No
eInvoice	object	E-invoicing settings	No

Bill To / Ship To Parameters

Either firstName and lastName, or company, is required.

Name	Type	Description	Required
firstName	string	First name (max 100 characters)	No
lastName	string	Last name (max 100 characters)	No
company	string	Company name (max 100 characters)	No
email	string	Email address (lowercase)	No
phone	string	Phone number (max 50 characters)	No
address	string	Street address (max 500 characters)	No
city	string	City (max 100 characters)	No
state	string	State or province (max 100 characters)	No
postalCode	string	Postal code (max 20 characters)	No
country	string	ISO 3166-1 alpha-2 country code, e.g. US	No
legal	string	Any legal details to show on documents (max 100 characters)	No

info

If firstName is provided, lastName must also be provided.

Tax / Registration Parameters

Name	Type	Description	Required
id	string	Identifier value (max 50 characters)	Yes, if name is provided
name	string	Identifier name, e.g. VAT ID (max 50 characters)	No

Peppol Parameters

schemeId and participantId must be provided together.

Name	Type	Description	Required
schemeId	string	4-digit Peppol EAS scheme code, e.g. 0225 for France	No
participantId	string	Peppol participant identifier (max 130 characters)	No

E-Invoice Parameters

Name	Type	Description	Required
standard	string	E-invoicing standard for the customer's documents, possible values are XRechnung (German CIUS of EN 16931), FacturX (Factur-X hybrid PDF), or PeppolBis (Peppol BIS Billing 3.0). If omitted, plain PDFs are issued	No

Update Customer

PUT https://api.invoiless.com/v1/customers/:id

PATCH https://api.invoiless.com/v1/customers/:id

Update an existing customer. See PUT vs PATCH for details on the differences.

Path Parameters

Name	Type	Description	Required
id	string	Customer id	Yes

Body Parameters

Accepts the same parameters as Create Customer.

Get Customer

GET https://api.invoiless.com/v1/customers/:id

Retrieve a specific customer by ID.

Path Parameters

Name	Type	Description	Required
id	string	Customer id	Yes

Get Customers

GET https://api.invoiless.com/v1/customers

Retrieve a paginated list of all customers.

Query Parameters

Name	Type	Description	Required
page	number	Page number	No, default is 1
limit	number	Page limit	No, default is 50
search	string	Search by customer name, email, phone, or tags	No

Delete Customer

DELETE https://api.invoiless.com/v1/customers/:id

Permanently delete a customer.

Path Parameters

Name	Type	Description	Required
id	string	Customer id	Yes