add_one_customer

Create New Customer

This endpoint allows you to create a new business customer in the system.forst check if use have permission for add new customer or not base on user token on header

Request Body Parameters

first_name (text, required): The first name of the customer.

last_name (text, optional): The last name of the customer.

email (text, required, unique): The email address of the customer.

phone (text, required, unique): The phone number of the customer.

address1 (text, optional): The primary address of the customer.

address2 (text, optional): The secondary address of the customer.

country_id (number, required): The ID of the country from the ecommerce system.

city (number, optional): The city of the customer based on the selected country.

state (number, optional): The state of the customer based on the selected city.

postcode (number, optional): The postal code of the customer.

vat_number (number, optional): The VAT number of the customer.

vat_number_check (number): 1 for VAT number check, 0 for no check.

company_name (text, optional): The name of the company.

business_identifier (text, optional): The business identifier.

billing_address (text, optional): The billing address of the customer.

delivery_address (text, optional): The delivery address of the customer.

credit_limit (number, optional): The credit limit of the customer.

user_type (text): 1 for customer, 2 for supplier.

customer_type (number, optional): The type of customer.

user_cat_id (number, optional): The user category ID based on the business.

currency (number): The currency required based on the business.

longitude (text, optional): The longitude of the customer location.

latitude (text, optional): The latitude of the customer location.

image (file, optional): The image of the customer.

bank_name (text, optional): The name of the bank.

bank_account_number (number, optional): The bank account number of the customer.

bank_iban_number (number, optional): The IBAN number of the bank.

commercial_register (file, optional): The commercial register information.

send_confirm_message (number): 1 to send confirmation message with password, 0 for no message.

status (number): 1 for active, 0 for not active.

Response

Status: 201

Content-Type: application/json

status (boolean): Indicates the status of the request.

message (string): A message related to the request.

data (object): The data of the created customer including various attributes such as UUID, name, email, phone, address, user type, business ID, currency, status, etc.

Example Response

{
    "status": true,
    "message": "",
    "data": {
        "uuid": "",
        "first_name": "",
        "last_name": "",
        "email": "",
        "phone": "",
        "address1": "",
        "address2": "",
        "country_id": "",
        "city": null,
        "state": "",
        "postcode": "",
        "vat_number": "",
        "vat_number_check": "",
        "company_name": "",
        "business_identifier": "",
        "billing_address": "",
        "delivery_address": "",
        "credit_limit": "",
        "user_type": 0,
        "business_id": 0,
        "customer_type": null,
        "user_cat_id": "",
        "currency": "",
        "longitude": "",
        "latitude": "",
        "image": "",
        "bank_name": "",
        "bank_account_number": "",
        "bank_iban_number": "",
        "commercial_register": "",
        "send_confirm_message": 0,
        "status": 0,
        "updated_at": "",
        "created_at": "",
        "id": 0
    }
}

curl --location --request POST 'https://taccounting.vodoerp.com/api/v4/customers' \ --header 'secure-business-key: 4765066450c0bd66325.48403130' \ --header 'platform: web' \ --header 'platform-key: 123333' \ --header 'Accept-Language: ar' \ --header 'apikey: efe2db322a53' \ --header 'userToken: 8720215f637bd51adfe2a180f90c36212ede0eab4937cc4319ecb68c3d7eb3cc' \ --form 'first_name="Halee"' \ --form 'last_name="Obrien"' \ --form 'email="jazedimet@mailinator.com"' \ --form 'phone="+11473984474"' \ --form 'address1="Bevis Hester"' \ --form 'address2="Perry Jackson"' \ --form 'country_id="1"' \ --form 'city="3667"' \ --form 'state="4519"' \ --form 'postcode="Price Raymond"' \ --form 'vat_number="null,"' \ --form 'vat_number_check="1"' \ --form 'company_name="York and Gray Trading"' \ --form 'business_identifier="Noelani Hart"' \ --form 'billing_address="Maryam Frank"' \ --form 'delivery_address="Macey Gaines"' \ --form 'credit_limit="791"' \ --form 'user_type="1,"' \ --form 'customer_type="null,"' \ --form 'user_cat_id=""' \ --form 'currency="2"' \ --form 'longitude="31.1814"' \ --form 'latitude="30.0244"' \ --form 'image=""' \ --form 'bank_name="Maya Lott"' \ --form 'bank_account_number="82"' \ --form 'bank_iban_number="813"' \ --form 'commercial_register=""' \ --form 'send_confirm_message="1"' \ --form 'status="1"'

{ "status": true, "message": "customer created", "data": { "uuid": "57d133aa-e077-4980-bc33-a44c74c8d878", "first_name": "Halee", "last_name": "Obrien", "email": "jazedimet@mailinator.com", "phone": "+11473984474", "address1": "Bevis Hester", "address2": "Perry Jackson", "country_id": "1", "city": null, "state": "4519", "postcode": "Price Raymond", "vat_number": "null,", "vat_number_check": "1", "company_name": "York and Gray Trading", "business_identifier": "Noelani Hart", "billing_address": "Maryam Frank", "delivery_address": "Macey Gaines", "credit_limit": "791", "user_type": 1, "business_id": 259, "customer_type": null, "user_cat_id": "", "currency": "2", "longitude": "31.1814", "latitude": "30.0244", "image": "", "bank_name": "Maya Lott", "bank_account_number": "82", "bank_iban_number": "813", "commercial_register": "", "send_confirm_message": 1, "status": 1, "updated_at": "2025-04-06T10:46:27.000000Z", "created_at": "2025-04-06T10:46:27.000000Z", "id": 41130 } }

Request

Header Params

secure-business-key

string

required

this secure key from Accounts System base on business

Example:

4765066450c0bd66325.48403130

platform

string

required

base on platform use this value now

Example:

web

platform-key

string

required

base on platform use this value now

Example:

123333

Accept-Language

string

required

ar or en

Example:

apikey

string

required

accounting system api key for secure request

Example:

efe2db322a53

userToken

string

required

from login request in accounts APIs https://documenter.getpostman.com/view/20887296/2sAYkHoJLt#fbaa67f3-66ef-4e1c-a304-2897fcae50d3

Example:

8720215f637bd51adfe2a180f90c36212ede0eab4937cc4319ecb68c3d7eb3cc

Body Params multipart/form-data

first_name

string

required

Example:

Halee

last_name

string

required

optional

Example:

Obrien

string

required

required,unique in business

Example:

jazedimet@mailinator.com

phone

string

required

required,unique in business

Example:

+11473984474

address1

string

required

optional

Example:

Bevis Hester

address2

string

required

optional

Example:

Perry Jackson

country_id

string

required

required from country list in ecommerce sustem from here https://documenter.getpostman.com/view/32977971/2sAYkHodX8#759ae634-b803-424c-8b18-bb731bef195e

Example:

city

string

required

optional from ecommerce request base on country
https://documenter.getpostman.com/view/32977971/2sAYkHodX8#552e6f1b-1964-44b6-b3f8-5b3aeaea2eaf

Example:

3667

state

string

required

optional base on city from here
https://documenter.getpostman.com/view/32977971/2sAYkHodX8#3991a78c-7427-49c0-af47-65380c623bec

Example:

4519

postcode

string

required

optional

Example:

Price Raymond

vat_number

string

required

optional id vat number check not set

Example:

null,

vat_number_check

string

required

1 or 0

Example:

company_name

string

required

optional

Example:

York and Gray Trading

business_identifier

string

required

optional

Example:

Noelani Hart

billing_address

string

required

optional

Example:

Maryam Frank

delivery_address

string

required

optional

Example:

Macey Gaines

credit_limit

string

required

optional

Example:

791

user_type

string

required

1 for sustomer or 2 for supplier

Example:

customer_type

string

required

optional

Example:

null,

user_cat_id

string

required

optional base on business from here
https://documenter.getpostman.com/view/23171355/2sAYkKJHmK#1bc372ee-8d15-4cb1-98d5-042abad1d851

currency

string

required

required from here base on business
https://documenter.getpostman.com/view/23171355/2sAYkKJHmK#00a4f1d6-3e76-486d-9fdb-2acb735ec7bb

Example:

longitude

string

required

optional

Example:

31.1814

latitude

string

required

optional

Example:

30.0244

image

string

required

optional

bank_name

string

required

optional

Example:

Maya Lott

bank_account_number

string

required

optional

Example:

bank_iban_number

string

required

optional

Example:

813

commercial_register

string

required

optional

send_confirm_message

string

required

1 for send confirm messsag e with password

Example:

status

string

required

1 for active or 0 for notactive

Example:

Responses

🟢201add_one_customer

application/json

Body

status

boolean

required

message

string

required

data

object

required

uuid

string

required

first_name

string

required

last_name

string

required

string

required

phone

string

required

address1

string

required

address2

string

required

country_id

string

required

city

null

required

state

string

required

postcode

string

required

vat_number

string

required

vat_number_check

string

required

company_name

string

required

business_identifier

string

required

billing_address

string

required

delivery_address

string

required

credit_limit

string

required

user_type

integer

required

business_id

integer

required

customer_type

null

required

user_cat_id

string

required

currency

string

required

longitude

string

required

latitude

string

required

image

string

required

bank_name

string

required

bank_account_number

string

required

bank_iban_number

string

required

commercial_register

string

required

send_confirm_message

integer

required

status

integer

required

updated_at

string

required

created_at

string

required

integer

required

Create New Customer#

Request Body Parameters#

Response#

Example Response#

Request

Responses

Create New Customer

Request Body Parameters

Response

Example Response