API Reference

Create customer

post
https://ecm.cert.ceretax.net/customers

Create a new customer in CereTax, together with its contacts, addresses, DBAs, and alternate IDs.

A customer is uniquely identified within a client by the combination of customerAccount and systemOriginId. Posting a duplicate returns a 422.

customerName, customerAccount, and at least one contact are always required. taxpayerId is additionally required when your account is configured to require a taxpayer ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The payload used to create a customer. taxpayerId becomes required when your account is configured to require a taxpayer ID.

string
required
length ≤ 255

The name of the customer.

string
required
length ≤ 255

The customer reference code from your billing, accounting, and/or ecommerce system for this customer. A customer is uniquely identified within your account by the combination of customerAccount and systemOriginId.

string
length ≤ 9

The customer's taxpayer identification number. This field is required when your account is configured to require a taxpayer ID.

string
length ≤ 255

The identifier of this customer in your source system.

integer
≥ 0
Defaults to 0

The ID of the user creating this customer. If no value is provided, 0 is used.

contacts
array of objects
required
length ≥ 1

A list of contacts associated with this customer. At least one contact is required.

contacts*

A contact associated with a customer. At least one contact is required when a customer is created.

If no contact is flagged as preferred, the first contact in the list is flagged automatically. Flagging more than one contact as preferred is rejected.

integer

The ID of an existing contact. Omit this field to add a new contact. When it is supplied, the matching contact is updated, and an ID that does not belong to the customer is rejected.

string
required
length ≤ 50

The name of the contact.

string
required
length ≤ 255

The email address of the contact.

string

The phone number of the contact. This is an optional field. The value accepts an optional leading plus sign ( + ) followed by digits, spaces, hyphens, periods, and parentheses, and must contain 10 to 15 digits. The value is stored digits-only.

string

The fax number of the contact. This is an optional field and follows the same format rules as phoneNumber.

boolean
Defaults to false

Indicates if this is the preferred contact for the customer. At most one contact per customer may be set to true.

addresses
array of objects

A list of addresses associated with this customer.

addresses
dbas
array of objects

A list of "doing business as" names associated with this customer.

dbas
alternateIds
array of objects

A list of alternate identifiers associated with this customer.

alternateIds
Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?