# Customers

# Create Customer

# HTTP Request

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

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
cc array[string] Cc recipients No
bcc array[string] Bcc recipients No
currency string ISO 4217 (opens new window) currency code e.g. USD, EUR etc No
lang string Customer language, possible values are en, fr, de, nl, es, bg, ro, ja, or mn 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 No
tags array[string] Tags No

# Bill To / Ship To Parameters

Either firstName and lastName, or company, is required.

Name Type Description Required
firstName string First name No
lastName string Last name No
company string Company name No
email string Email No
phone string Phone No
address string Address No
legal string Legal info (e.g. Company number) No

# Update Customer

# HTTP Request

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

# Path Parameters

Name Type Description Required
id string Customer id Yes

# Get Customer

# HTTP Request

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

# Path Parameters

Name Type Description Required
id string Customer id Yes

# Get Customers

# HTTP Request

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

# Query Parameters

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

# Delete Customer

# HTTP Request

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

# Path Parameters

Name Type Description Required
id string Customer id Yes