Add New Client

curl --location -g --request POST 'https://.daftra.com/api2/clients' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "Client": { "is_offline": true, "client_number": "0000715", "staff_id": 0, "business_name": "John Smith", "first_name": "", "last_name": "", "email": "user@example.com", "password": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "postal_code": "string", "phone1": "string", "phone2": "string", "country_code": "str", "notes": "string", "active_secondary_address": true, "secondary_name": "string", "secondary_address1": "string", "secondary_address2": "string", "secondary_city": "string", "secondary_state": "string", "secondary_postal_code": "string", "secondary_country_code": "string", "default_currency_code": "strin", "follow_up_status": null, "category": "string", "group_price_id": 0, "timezone": 0, "bn1": "string", "bn1_label": "string", "bn2_label": "string", "bn2": "string", "starting_balance": null, "type": null, "birth_date": "2018-05-10", "gender": null, "map_location": null, "credit_limit": 0, "credit_period": 0 } }'

Request

Path Params

format

string

required

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Body Params application/json

Client

object

ClientBase

optional

is_offline

boolean

optional

0 / 1 indicates if the Client is offline

client_number

string

optional

Visual identifier for the Client

Example:

0000715

staff_id

integer <int64>

optional

Staff ID who created the invoice get it from GET STAFF API if it's 0 that means the site owner is the staff that created it

Default:

Example:

business_name

string

required

Client's business name

<= 100 characters

Example:

John Smith

first_name

string

required

Client's first name

<= 255 characters

Example:

last_name

string

required

Client's last name

<= 255 characters

Example:

string <email>

required

Client's email

<= 255 characters

password

string

write-onlyrequired

Client's password

<= 255 characters

address1

string

optional

Client's Address line 1

<= 255 characters

address2

string

optional

Client's Address line 2

<= 255 characters

city

string

optional

Client's City

<= 100 characters

state

string

optional

Client's State

<= 100 characters

postal_code

string

optional

Client's postal code

<= 20 characters

phone1

string

optional

Client's phone number

<= 50 characters

phone2

string

optional

Client's mobile number

<= 50 characters

country_code

string

optional

Client's country ISO "ALPHA-2 Code

<= 3 characters

notes

string

optional

Notes for the Client

active_secondary_address

boolean

optional

0/1 if the secondary data is active.

secondary_name

string

optional

Client's name

<= 255 characters

secondary_address1

string

optional

Client's address line 1

<= 255 characters

secondary_address2

string

optional

Client's address line 2

<= 255 characters

secondary_city

string

optional

Client's City

<= 100 characters

secondary_state

string

optional

Client's State

<= 100 characters

secondary_postal_code

string

optional

Client's postal code

<= 50 characters

secondary_country_code

string

optional

Client's country ISO "ALPHA-2 Code

<= 10 characters

default_currency_code

string

optional

3 Digit currency code following ISO 4217 standard

<= 5 characters

follow_up_status

integer | null

optional

Follow Up Status get it from GET Follow up statuses with model client

Default:

null

Request

Responses