Overview

Customers are entities that purchase goods or services from a company. They can be used on Invoices and Contracts.

The Customer Object

string<uuid>

Unique identifier for the object

name

string

Name of the customer

string | null

Email address of the customer

address

object

Show child attributes

status

enum<string>

Current status of the customer

ACTIVE - The customer is active and can be used in invoices and contracts
ARCHIVED - The customer is archived and cannot be used in new invoices or contracts

Available options:

ACTIVE,

ARCHIVED

description

string | null

Description or notes about the customer

vatNumber

string | null

VAT number of the customer

businessRegistrationNumber

string | null

Business registration number of the customer

easCode

string | null

Electronic Address Scheme code used for sending e-invoices

einvoiceAddress

string | null

E-invoice address for the customer

einvoiceNetwork

enum<string> | null

E-invoice network the customer is registered on

NEMHANDEL - NemHandel e-invoice network
PEPPOL - Peppol e-invoice network
SDI - SDI (Sistema di Interscambio) e-invoice network

Available options:

NEMHANDEL,

PEPPOL,

SDI

type

enum<string> | null

Type of customer

BUSINESS - Business customer
CONSUMER - Consumer customer
GOVERNMENT - Government customer

Available options:

BUSINESS,

CONSUMER,

GOVERNMENT

logoUrl

string | null

URL to the customer's logo

domain

string | null

Domain of the customer's website

externalSource

object | null

The external system where this product was synced from

Show child attributes

createdAt

string<date-time>

Timestamp when the customer was created

updatedAt

string<date-time>

Timestamp when the customer was last updated

customProperties

object[] | null

List of custom properties associated with the customer

Show child attributes

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "email": "<string>", "address": { "country": "UNDEFINED", "city": "<string>", "state": "<string>", "zipcode": "<string>", "street": "<string>", "street2": "<string>" }, "status": "ACTIVE", "description": "<string>", "vatNumber": "<string>", "businessRegistrationNumber": "<string>", "easCode": "<string>", "einvoiceAddress": "<string>", "einvoiceNetwork": "NEMHANDEL", "type": "BUSINESS", "logoUrl": "<string>", "domain": "<string>", "externalSource": { "name": "CHARGEBEE", "externalId": "<string>" }, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "customProperties": [ { "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "groupInternalName": "<string>", "values": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "groupInternalName": "<string>", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "internalName": "<string>", "label": "<string>", "context": "<string>", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" } ] } ] }

Accounting Documents

Attachments

Authorization

Card Customers

Card Transactions

Cards

Companies

Credit Notes

Custom Properties

Customers

Entities

Exchange

Expenses

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

LCI

Ledger Transactions

Ledger accounts

Products

Purchase Orders

Users

Vendors

The Customer Object

Accounting Documents

Attachments

Authorization

Card Customers

Card Transactions

Cards

Companies

Credit Notes

Custom Properties

Customers

Entities

Exchange

Expenses

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

LCI

Ledger Transactions

Ledger accounts

Products

Purchase Orders

Users

Vendors

​The Customer Object

The Customer Object