API Docs
API Docs
  1. Customers
  • Getting Started
    • Introduction to Sales Tax Calculation
    • Step By Step - Creating your first transaction
    • Step By Step - Creating VAT / Global Tax Transaction
  • Endpoints
    • Authentication
      • Authentication - Getting Started
      • Create JWT
    • Customers
      • Get to Know
      • Get Customer
        GET
      • Get All Customers
        GET
      • Upsert Customer
        PUT
      • Update Customer
        PATCH
    • Exemptions
      • Get to Know
      • Get All Exemptions
      • Post Exemption
      • Update Exemption
      • Patch Exemption
    • Transactions
      • Get to Know
      • The Importance of Shipping Address
      • How to Use Credit Memos
      • Get Transaction (thin)
      • Get Transaction
      • Upsert Transaction
      • Delete Transaction
      • Get All Transactions (thin)
      • Get All Transactions
      • Upsert VAT / GT Transactio
    • Address Validation
      • Address Validation Intro
      • Validate Address
    • Sales Tax Rates
      • Get Sales Tax Rates
    • Vat Validation
      • Validate Vat
  • Special Features
    • Global Tax Rate
    • Partial Address
    • Discounts
    • Inclusive Tax
    • Vat Validation
    • Post exemptions from CSV
      POST
  • Applications
    • Xero - Integration & User Manual
  1. Customers

Upsert Customer

PUT
/v1/customers/source/{source}/externalId/{externalId}
Update or Insert Customer by External ID and source

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
source
string 
required
Example:
{{source}}
externalId
string 
required
The Id of the customer in your system
Example:
{{customerExternalId}}
Body Params application/json
The buyer. All transactions are associated with a customer
complytId
string <uuid>
optional
The unique identifier in Complyt of the customer
externalId
string 
required
the attribute designed to receive a unique identifier provided by API consumers themselves (e.g. pass your own ID)
>= 1 characters<= 256 characters
source
string 
required
a single digit which identifies your different stores, checkout solutions, marketplaces, etc. defined by the API consumers (to avoid external id duplications)
Match pattern:
^(10|[1-9])$
name
string 
optional
The customer's name
>= 1 characters<= 256 characters
address
object 
optional
city
string 
optional
>= 0 characters<= 100 characters
country
string 
optional
>= 0 characters<= 50 characters
county
string 
optional
>= 0 characters<= 100 characters
state
string 
optional
>= 0 characters<= 100 characters
street
string 
optional
>= 0 characters<= 200 characters
region
string 
optional
>= 0 characters<= 20 characters
zip
string 
optional
>= 0 characters<= 20 characters
email
string 
optional
An (Optional) Email address associated with the customer
customerType
enum<string> 
optional
Indicates whether the customer is 'retail'/'reseller'/'marketplace'. Defaults to 'retail' if no customer type is provided
Allowed values:
RETAILMARKETPLACERESELLERRETAIL_EXEMPT
internalTimestamps
object (internalTimestamps) 
optional
read-only. The APIs internal timestamps for this resource
createdDate
string 
required
valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/ 'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid time zone offset).
updatedDate
string 
required
valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/ 'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid time zone offset).
externalTimestamps
object (externalTimestamps) 
required
External timestamps, which should reference the dates in your originating system since these are the timestamps used for sales tax calculation
createdDate
string 
required
The creation time of the transaction
updatedDate
string 
required
The last update time of the transaction
comment
string 
optional
>= 0 characters<= 200 characters
Example
{
    "externalId": "{{customerExternalId}}",
    "source": "{{source}}",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823"
    },
    "customerType": "RETAIL",
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00.000Z",
        "updatedDate": "2022-10-19T09:07:54.585Z"
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https://sandbox.complyt.io/v1/customers/source//externalId/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "",
    "source": "",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823"
    },
    "customerType": "RETAIL",
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00.000Z",
        "updatedDate": "2022-10-19T09:07:54.585Z"
    }
}'

Responses

🟢200Successful operation
application/json
Body
The buyer. All transactions are associated with a customer
complytId
string <uuid>
optional
The unique identifier in Complyt of the customer
externalId
string 
required
the attribute designed to receive a unique identifier provided by API consumers themselves (e.g. pass your own ID)
>= 1 characters<= 256 characters
source
string 
required
a single digit which identifies your different stores, checkout solutions, marketplaces, etc. defined by the API consumers (to avoid external id duplications)
Match pattern:
^(10|[1-9])$
name
string 
optional
The customer's name
>= 1 characters<= 256 characters
address
object 
optional
city
string 
optional
>= 0 characters<= 100 characters
country
string 
optional
>= 0 characters<= 50 characters
county
string 
optional
>= 0 characters<= 100 characters
state
string 
optional
>= 0 characters<= 100 characters
street
string 
optional
>= 0 characters<= 200 characters
region
string 
optional
>= 0 characters<= 20 characters
zip
string 
optional
>= 0 characters<= 20 characters
email
string 
optional
An (Optional) Email address associated with the customer
customerType
enum<string> 
optional
Indicates whether the customer is 'retail'/'reseller'/'marketplace'. Defaults to 'retail' if no customer type is provided
Allowed values:
RETAILMARKETPLACERESELLERRETAIL_EXEMPT
internalTimestamps
object (internalTimestamps) 
optional
read-only. The APIs internal timestamps for this resource
createdDate
string 
required
valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/ 'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid time zone offset).
updatedDate
string 
required
valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/ 'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid time zone offset).
externalTimestamps
object (externalTimestamps) 
required
External timestamps, which should reference the dates in your originating system since these are the timestamps used for sales tax calculation
createdDate
string 
required
The creation time of the transaction
updatedDate
string 
required
The last update time of the transaction
comment
string 
optional
>= 0 characters<= 200 characters
Example
{
    "complytId": "9f8ee193-1a71-42b4-801d-ee1d8a161fbe",
    "externalId": "externalIdExample",
    "source": "1",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "county": null,
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823",
        "isPartial": false
    },
    "email": "example@some.mail.com",
    "customerType": "RETAIL",
    "internalTimestamps": {
        "createdDate": "2023-01-10T17:40:44.357",
        "updatedDate": "2023-01-11T17:10:21.275"
    },
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00",
        "updatedDate": "2022-10-19T09:07:54.585"
    },
    "comment": "this is a customer"
}
🟢201Successful operation
🟠400Something is wrong with your request
🟠401Unauthorized
🟠403Forbidden
🟠404Customer Not Found
🔴500Internal Error
Modified at 2025-01-01 15:21:30
Previous
Get All Customers
Next
Update Customer
Built with