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",
  "companyUuid": "a169f209-b362-4a01-add2-c7bd7f0be6cb",
  "regionCode": "GBR",
  "address": {
    "line1": "10 High Street",
    "line2": "",
    "townCity": "London",
    "country": "England",
    "postcode": "SW1A 1AA"
  },
  "email": "billing@acme.com",
  "contactName": "Jane Smith",
  "phone": {
    "countryCode": "44",
    "number": "1234567890"
  }
}'

{
  "uuid": "45b0d09b-bc25-4b45-af21-dc15cba56ce2",
  "entityName": "Acme Corp",
  "tradingName": "Acme",
  "regionCode": "GBR",
  "address": {
    "line1": "10 High Street",
    "line2": "string",
    "townCity": "London",
    "country": "England",
    "foreignCountry": "string",
    "postcode": "SW1A 1AA"
  },
  "email": "billing@acme.com",
  "contactName": "Jane Smith",
  "remoteId": 1,
  "phone": {
    "countryCode": "44",
    "number": "1234567890"
  },
  "registrationNumber": "AA123234",
  "invoiceTermLength": 30,
  "salesInvoiceDescriptionText": "string",
  "parentUuid": "string",
  "invoiceTaxUuid": "string",
  "companyUuid": "string",
  "billingGroupName": "string",
  "billingGroupInvoiceName": "string",
  "billingGroupPrimaryEmail": "string",
  "billingGroupAdditionalEmailRecipients": "string",
  "billingGroupUuid": "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

companyUuidstringRequiredformat: "uuid"

regionCodestringOptional

Region code

addressobjectOptional

Company address

emailstringOptionalformat: "email"<=100 characters

contactNamestringOptional

remoteIdintegerOptional

ID from an external system

phoneobjectOptional

registrationNumberstringOptional

invoiceTermLengthintegerOptional

Payment terms in days

salesInvoiceDescriptionTextstringOptional<=500 characters

parentUuidstringOptionalformat: "uuid"

UUID of a parent customer

invoiceTaxUuidstringOptionalformat: "uuid"

billingGroupNamestringOptional

billingGroupInvoiceNamestringOptional

billingGroupPrimaryEmailstringOptionalformat: "email"<=100 characters

billingGroupAdditionalEmailRecipientsstringOptional

billingGroupUuidstringOptionalformat: "uuid"

Response

Customer created successfully

uuidstringOptionalformat: "uuid"

entityNamestringOptional

tradingNamestringOptional