Add New Client

Production

https://{{subdomain}}.daftra.com/api2

POST

/clients{format}

Creates a new client.

The request body wraps the client fields in a Client object. business_name is the only always-required field. email is required only when the client's invoicing method is email; when no email is supplied the client is created as offline. Optional ClientDetail and le_custom_data_client objects carry additional and custom-field data. Requires the Add New Client permission. Returns 202 with the new client's id and client_number.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

Created

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠402Payment Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/clients?skip_email=undefined&verify_phone2=undefined' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{"Client": {"business_name": "John Smith", "type": 3, "email": "john@example.com", "phone1": "+201000000000", "country_code": "EG", "default_currency_code": "EGP"}}'

Response Example

202 - Example 1

{
    "result": "successful",
    "code": 202,
    "id": 512,
    "client_number": "0000715"
}

GET Single Client

Edit Clients