Get_Customers

This endpoint makes an HTTP GET request to retrieve a list of business customers and with optional filters for first name, last name, and customer IDs. The request does not include a form-data request body.

Request Body

No request body provided.

Response

Status: 200

Content-Type: application/json

Response Body

The response will include a JSON object with a "status" field indicating the success of the request, a "message" field for any additional information, and a "data" array containing customer details such as UUID, first name, last name, company name, email, phone, ID, creation date, customer receivable total, customer wallet balance, invoice count, and total invoice amount.

Example Response:

{
    "status": true,
    "message": "",
    "data": [
        {
            "uuid": "",
            "first_name": "",
            "last_name": null,
            "company_name": "",
            "email": "",
            "phone": "",
            "id": 0,
            "created_at": "",
            "customer_receivable_total": 0,
            "customer_wallet": 0,
            "customer_invoice_count": 0,
            "customer_invoice_total": 0
        }
    ]
}

curl --location --request GET 'https://taccounting.vodoerp.com/api/v4/customers?pagination=false&filter_first_name=&filter_last_name=&filter_customers_ids=40583,40577' \ --header 'secure-business-key: 14807664478836358b0.31329842' \ --header 'Accept-Language: ar' \ --header 'apikey: efe2db322a53' \ --header 'platform-key: 123456789' \ --header 'platform: web'

{ "status": true, "message": "done", "data": [ { "uuid": "fb1a9ff0-3cb7-45a3-9ac3-3e96a41f228d", "first_name": "allaa_vodo_144", "last_name": null, "company_name": "", "email": "allaa_vodo_185@qodiq.com", "phone": "+201092014978", "id": 40583, "created_at": "2025-02-19T09:10:11.000000Z", "customer_receivable_total": 0, "customer_wallet": 0, "customer_invoice_count": 0, "customer_invoice_total": 0 }, { "uuid": "e1aa9ae2-c33b-48ab-afaf-b2735be5db62", "first_name": "asdas asaaaa", "last_name": null, "company_name": null, "email": "mbb958256@gmail.com", "phone": "+966123211444421", "id": 40577, "created_at": "2025-02-18T14:18:30.000000Z", "customer_receivable_total": 0, "customer_wallet": 0, "customer_invoice_count": 0, "customer_invoice_total": 0 } ] }

Request

Query Params

status

string

optional

filter by customer status

Example:

active

keyword

string

optional

keyword search

filter_company_name

string

optional

filter by company name

filter_vat_number

string

optional

filter by vat number

filter_phone

string

optional

filter_email

string

optional

filter_customer_name

string

optional

filter by customer first name or last name

Example:

شهد صالح

filter_from_date

string

optional

filter_to_date

string

optional

filter__user_id

string

optional

pagination

string

required

true for full list or false to page list

Example:

false

filter_first_name

string

required

filter by customer first name

filter_last_name

string

required

filter by customer last name

filter_customers_ids

string

required

filter by customers ids

Example:

40583,40577

Header Params

secure-business-key

string

required

Example:

14807664478836358b0.31329842

Accept-Language

string

required

Example:

apikey

string

required

Example:

efe2db322a53

platform-key

string

required

Example:

123456789

platform

string

required

Example:

web

Body Params multipart/form-data

object {0}

Responses

🟢200Get_Customers

application/json

Body

status

boolean

required

message

string

required

data

array [object {12}]

required

uuid

string

required

first_name

string

required

last_name

null

required

company_name

string | null

required

string

required

phone

string

required

integer

required

created_at

string

required

customer_receivable_total

integer

required

customer_wallet

integer

required

customer_invoice_count

integer

required

customer_invoice_total

integer

required

Request Body#

Response#

Response Body#

Request

Responses

Request Body

Response

Response Body