Attention!

Looking for the most up-to-date Sales Tax Filing or CertManager documentation? Go to our new documentation platform, Sovos Docs. For Global Tax Determination, connector and CertManager API docs, stay here.

Create a new customer

Request information

  • HTTP method: POST
  • Content-type header: application/json
  • URL
    • CertManager UAT:
      https://certmanager-uat.sovos.com/api/pre-auth/v1/configuration/customers
    • CertManager Production:
      https://certmanager.sovos.com/api/pre-auth/v1/configuration/customers

JSON request fields

Field

Data type

Required or optional

Description
customerName String Required Customer name
customerNumber String Required Customer number
contactName String Optional Customer contact's name
email String Optional Customer contact's email
phoneNumber String Optional Customer contact's phone number
faxNumber String Optional Customer contact's fax number
notes String Optional Notes about the customer
emailCampaignPreference String Optional

If O, the customer the email is addressed to will receive the email

(For child customers) If P, the parent customer will receive the customer's email

(For parent customers) If F, the customer will receive emails for their child customers
customerAddresses List Optional

List of customer's addresses/locations
replyToContactName String Optional

Customer representative's name
replyToContactEmail String Optional

Customer representative's email

customerAddresses fields

Field

Data type

Required or optional

Description
address1 String Optional

Address line 1
address2 String Optional

Address line 2
city String Optional

City
zipCode String Optional

ZIP code
zipPlus4 String Optional

Four-digit ZIP code extension
stateCode String Optional

Two-letter state or province code
stateName String Optional

State or province name
countryCode String Optional

Two-letter country code
country String Optional

Country name
addressName String Optional

Address name
phoneNumber String Optional

Address phone number
faxNumber String Optional

Address fax number
notes String Optional

Notes about the address

Example request

{
     "phoneNumber": "1234567890",
     "faxNumber": "0987654321",
     "notes": "some notes",
     "emailCampaignPreference": "O",
     "customerAddresses": [
          {
               "state": {
                    "stateCode": "MA",
                    "stateName": "MASSACHUSETTS",
                    "countryCode": "US",
                    "jurisdictionId": 273 //optional
               },
               "addressName": "location 1 name",
               "address1": "1 Main St",
               "address2": "4th Floor",
               "city": "Boston",
               "zipCode": "11111",
               "zipPlus4": "4444",
               "phoneNumber": "1112223333",
               "faxNumber": "4445556666",
               "notes": "location notes"
          }
     ],
     "customerName": "exampleName",
     "customerNumber": "exampleNumber",
     "contactName": "contactName",
     "email": "email@test.com",
     "replyToContactName": "rep name",
     "replyToContactEmail": "rep@email.com"
}

Example response    

{
    "status": 200,
    "message": "CorrelationId: 0f4b8c6a-654c-4fb3-968f-5c9b1334cdfa - Created a customer",
    "data": {
        "customerId": "3b6a4a83-e917-42df-b1b3-9d501f73b4ec",
        "dateOfCreation": 1732632983484,
        "customerName": "CustomerNameExample",
        "customerNumber": "43242",
        "contactName": "Contact Name",
        "savedInGtd": null,
        "lastModified": 1732632983484,
        "lastModifiedBy": "modifier@example.com",
        "phoneNumber": "1234567890",
        "faxNumber": "0987654321",
        "notes": "notes field example",
        "replyToContactName": "Representative Name",
        "replyToContactEmail": "emailaddress@test.com",
        "gtdErrorMessage": null,
        "emailCampaignPreference": "O",
        "hasChildren": false,
        "numberOfChildren": null,
        "customerEmails": [
            {
                "email": "contact.email@test.com"
            }
        ],
        "customerAddresses": [
            {
                "addressId": 1616929,
                "address1": "1 Main Street",
                "address2": "2 Main Street",
                "city": "Boston",
                "zipCode": "11111",
                "zipPlus4": null,
                "state": null,
                "jurisdictionId": 273,
                "country": null,
                "addressName": "Location name",
                "phoneNumber": "1234567890",
                "faxNumber": "09876543231",
                "notes": "location notes",
                "exemptionExists": false
            }
        ],
        "parentId": null,
        "parentCustomer": null
    },
    "success": true
}