get_customers_branches
Testing Env
https://taccounting.vodoerp.com
Testing Env
https://taccounting.vodoerp.com
GET
/api/v4/customers_branches/branches/85d279d8-c3de-4d63-ba31-791f81083ff7
Last modified:2025-04-20 15:18:37
note:in url must pass customer uuid
| ** Query Param** | description |
|---|---|
| keyword | optional string keyword filter to filter list base on keyword input |
| paginate | optional stringtrue to show pagination list or false to show full list |
| per_page | optional stringnumber of items showin one page |
| filter_name | optional string name filter to filter list base on name input |
| filter_phone | optional string phone filter to filter list base on phone input |
| filter_vat_number | optional string vat number filter to filter list base on vat number input |
| HEADERS | description |
|---|---|
| Accept-Language | required stringar,en |
| secure-business-key | required string ex: 4765066450c0bd66325.48403130 from accounts system base on business |
| apikey | required string ex: efe2db322a53 for make reuest more secure must add apikey in header |
| platform-key | required string ex: 1234567 use this value as test |
| platform | required string ex: web use this value as test |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://taccounting.vodoerp.com/api/v4/customers_branches/branches/85d279d8-c3de-4d63-ba31-791f81083ff7?keyword=&paginate=true&per_page=5&filter_name=&filter_phone=&filter_vat_number=' \
--header 'secure-business-key: 14807664478836358b0.31329842' \
--header 'platform-key: 1234567' \
--header 'platform: web' \
--header 'Accept-Language: en' \
--header 'apikey: efe2db322a53' \
--header 'userToken: 0fb8e5e58d4d553a4cfb2267ef66cab5bdf021c60e73f502c28184ceda093af0'Response Response Example
{
"status": true,
"message": "done",
"data": {
"current_page": 1,
"data": [
{
"id": 65,
"uuid": "75a7e6b8-5682-48bd-b9de-ca536980a438",
"business_id": 256,
"company_id": 2586,
"name": "فرع مكة",
"vat_number": "1247892000012",
"vat_number_check": "0",
"phone": "+9665478128",
"email": "branch@gmail.com",
"address": "عنوان الشركة",
"longitude": null,
"latitude": null,
"country_id": 2,
"city": "125",
"state": null,
"district": null,
"status": 1,
"created_at": "2025-04-17T16:45:11.000000Z",
"updated_at": "2025-04-17T16:45:11.000000Z",
"company": {
"id": 2586,
"integration_id": null,
"integration_method": null,
"uuid": "9065b095-afb7-429c-9f1f-af5854cba9b1",
"business_id": 256,
"related_business_id": null,
"first_name": "allaa_vodo_144",
"last_name": null,
"user_name": "allaa_vodo_8440",
"email": "allaa_vodo_19@qodiq.com",
"token": null,
"email_verified_at": null,
"password": "$2y$10$SM31zLkevJpCalntRP8biutNizfMAohRvsKbRrvBXFYHf6Dscv4iq",
"phone": "+201092014978",
"address1": null,
"longitude": null,
"latitude": null,
"address2": null,
"address_type": null,
"country_id": 0,
"city": null,
"district": null,
"state": null,
"postcode": null,
"vat_number": null,
"vat_number_check": "0",
"company_name": "",
"currency": "126",
"business_identifier": null,
"billing_address": null,
"delivery_address": null,
"credit_limit": null,
"remember_token": null,
"user_type": "1",
"status": 1,
"started_balance": null,
"customer_type": "reservation",
"reservation_cust_id": null,
"image": "",
"send_confirm_message": 1,
"bank_name": null,
"bank_account_number": null,
"bank_iban_number": null,
"commercial_register": null,
"user_cat_id": 0,
"kiosk_code": null,
"kiosk_token": "111mmnnn",
"user_kiosk_token": null,
"kiosk_code_verified_at": null,
"job": "",
"login_token": null,
"created_at": "2025-04-06T21:04:29.000000Z",
"updated_at": "2025-04-06T21:04:29.000000Z",
"deleted_at": null
}
}
],
"first_page_url": "https://taccounting.vodoerp.com/api/v4/customers_branches/branches/9065b095-afb7-429c-9f1f-af5854cba9b1?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://taccounting.vodoerp.com/api/v4/customers_branches/branches/9065b095-afb7-429c-9f1f-af5854cba9b1?page=1",
"next_page_url": null,
"path": "https://taccounting.vodoerp.com/api/v4/customers_branches/branches/9065b095-afb7-429c-9f1f-af5854cba9b1",
"per_page": "5",
"prev_page_url": null,
"to": 1,
"total": 1
}
}Request
Query Params
keyword
string
required
paginate
string
required
Example:
true
per_page
string
required
Example:
5
filter_name
string
required
filter_phone
string
required
filter_vat_number
string
required
Header Params
secure-business-key
string
required
Example:
14807664478836358b0.31329842
platform-key
string
required
Example:
1234567
platform
string
required
Example:
web
Accept-Language
string
required
Example:
en
apikey
string
required
Example:
efe2db322a53
userToken
string
required
Example:
0fb8e5e58d4d553a4cfb2267ef66cab5bdf021c60e73f502c28184ceda093af0
Body Params multipart/form-data
object {0}