v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Customers

Add

This endpoint allows you to create a new customer in the system.

post/Customers/Add

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

emailstring required

Customer email address.

customer_namestring required

Customer name.

paying_vatboolean

Let's the system know if the customer is paying VAT or not.

vat_numberinteger

Customer or Company VAT number.

customer_numberstring

Internal customer number in the system.

notesstring

Notes, comments, or additional information about the customer.

phonestring

Customer phone number.

business_addressstring

Business address of the customer.

business_citystring

Business city.

business_postal_codestring

Business postal code.

business_country_isostring

Business country code.

subject_codestring

External customer number in other ERP or other systems.

communication_emailstring

Email for communication purposes.

Example request

{
  "contacts": [
    {
      "contact_country_iso": "IL"
    }
  ]
}

Response

200

Example response

{
  "results": {
    "status": "success",
    "description": "operation has been success"
  },
  "data": {
    "customer_uid": "84aa6e4e-fe42-4d5f-b9cd-59dbc3817f10"
  }
}

All 121 operations