Customer

Manage customers and their details, including company, contact, and payment information.
You can create, update, delete, and search for customers with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/customer/index

Returns a paginated and filterable list of customers.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching customers

object

filter

object

customer_id

string

entity_id

string

email

string

company

string

vat_number

string

cf_tax_code

string

taxability

string

first_name

string

last_name

string

phone

string

line1

string

line2

string

line3

string

city

string

state

string

country

string

zip

string

auto_collection

string

cf_payment_mtd

string

payment_source_id

string

reference_id

string

card_status

string

masked_number

string

card_type

string

card_expiry_month

integer

card_expiry_year

integer

cb_customer_id

string

locked

integer

project_id

string

project_name

string

partner_id

string

partner_name

string

subscription_id

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "company": "Acme Corp",
    "country": "Italy"
  },
  "per-page": 20,
  "page": 1,
  "sort": "company"
}

Responses

200

List of customers

Array<object>

object

customer_id

string

entity_id

string

email

string

company

string

vat_number

string

cf_tax_code

string

taxability

string

first_name

string

last_name

string

phone

string

line1

string

line2

string

line3

string

city

string

state

string

country

string

zip

string

auto_collection

string

cf_payment_mtd

string

payment_source_id

string

reference_id

string

card_status

string

masked_number

string

card_type

string

card_expiry_month

integer

card_expiry_year

integer

cb_customer_id

string

locked

integer

project_id

string

project_name

string

partner_id

string

partner_name

string

subscription_id

string

Example

{
  "customer_id": "c-1",
  "company": "Acme Corp",
  "email": "info@acme.com",
  "country": "Italy",
  "project_id": "p-1",
  "project_name": "Project X"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/customer/view/{id}

Retrieve a customer by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the customer to retrieve

Responses

200

Customer found

object

customer_id

string

entity_id

string

email

string

company

string

vat_number

string

cf_tax_code

string

taxability

string

first_name

string

last_name

string

phone

string

line1

string

line2

string

line3

string

city

string

state

string

country

string

zip

string

auto_collection

string

cf_payment_mtd

string

payment_source_id

string

reference_id

string

card_status

string

masked_number

string

card_type

string

card_expiry_month

integer

card_expiry_year

integer

cb_customer_id

string

locked

integer

project_id

string

project_name

string

partner_id

string

partner_name

string

subscription_id

string

Example

{
  "customer_id": "c-1",
  "company": "Acme Corp",
  "email": "info@acme.com",
  "country": "Italy",
  "project_id": "p-1",
  "project_name": "Project X"
}

404

Customer not found