Create Customer | Deel. PayAndBill API Documentation

curl -X POST https://{{baseurl}}/customers \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "entityName": "Acme Corp",
  "tradingName": "Acme",
  "regionCode": "GBR",
  "email": "billing@acme.com",
  "contactName": "Jane Smith",
  "phone": {
    "countryCode": "44",
    "number": "1234567890"
  },
  "address": {
    "line1": "10 High Street",
    "line2": "",
    "townCity": "London",
    "postcode": "SW1A 1AA",
    "country": "England"
  }
}'

{
  "uuid": "45b0d09b-bc25-4b45-af21-dc15cba56ce2",
  "entityName": "Acme Corp",
  "tradingName": "Acme",
  "regionCode": "GBR",
  "email": "string",
  "contactName": "string",
  "phone": {
    "countryCode": "44",
    "number": "1234567890"
  },
  "address": {
    "line1": "10 High Street",
    "line2": "string",
    "townCity": "London",
    "postcode": "SW1A 1AA",
    "country": "England"
  },
  "registrationNumber": "string",
  "invoiceTermLength": 1.1,
  "companyUuid": "string"
}

Create a new customer record.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

entityNamestringRequired

Company legal name

tradingNamestringRequired

Trading name

regionCodestringOptional

Region code

emailstringOptionalformat: "email"

contactNamestringOptional

phoneobjectOptional

addressobjectOptional

registrationNumberstringOptional

invoiceTermLengthdoubleOptional

Payment terms in days

salesInvoiceDescriptionTextstringOptional

parentUuidstringOptional

UUID of a parent customer

invoiceTaxUuidstringOptional

companyUuidstringOptional

billingGroupNamestringOptional

billingGroupInvoiceNamestringOptional

billingGroupPrimaryEmailstringOptionalformat: "email"

billingGroupAdditionalEmailRecipientsstringOptional

billingGroupUuidstringOptional

Response

Customer created successfully

uuidstring

entityNamestring

tradingNamestring

regionCodestring

emailstringformat: "email"

contactNamestring

phoneobject

addressobject

registrationNumberstring

invoiceTermLengthdouble

companyUuidstring

Errors

400

Bad Request Error

Authentication

Headers

Request

Response

Errors