Guides | Intend Knowledge Base

Last Updated Aug 15, 2025

Create a Client

post

api/clients/create

Registers a new client in the system, including contact details, billing and shipping addresses, and account credentials.

Request

Field	Description
`type`	[object] Client type details (see "Type object" below).
`department`	[string] Department name the client belongs to.
`title`	[string] Full title or company name of the client.
`first_name`	[string] Client's first name.
`last_name`	[string] Client's last name.
`email`	[string] Client's email address.
`credentials`	[object] Login credentials for the client (see "Credentials object" below).
`currency`	[string] Preferred currency code for the client.
`tax_ref`	[object] Tax reference details (see "Tax ref object" below).
`detail`	[object] Additional client details (see "Detail object" below).
`billing_address`	[object] Client's billing address details (see "Billing address" below).
`shipping_addresses`	[array] Shipping address details (see "Shipping address" below).
`contacts`	[array] Additional contact details for the client.
`source`	[string] Source from which the client record was created (e.g., web, system).
`source_status`	[string] Status of the client source.

Type object

Field	Description
`code`	[string] Code representing the client type (e.g., retail, trade).

Credentials object

Field	Description
`username`	[string] Client login username
`password`	[string] Client login password, will be hashed before storage.

Tax ref object

Field	Description
`code`	[string] Tax code assigned to the client.

Detail object

Field	Description
`contact_number`	[string] Contact phone number.
`contact_person`	[string] Name of contact person.
`website`	[string] Client's website URL.
`registration_number` (optional)	[string] Company registration number.
`registration_address` (optional)	[string] Company registrated address.
`company_number` (optional)	[string] Company number.
`eori_number` (optional)	[string] EORI (Economic Operators Registration and Identification) number.
`vat_number`	[string] VAT number.
`payment_term`	[string] Payment term.

Billing address object

Field	Description
`address_company`	[string] Company name for billing.
`address_contact_name`	[string] Contact name for billing contact.
`address_contact_email`	[string] Email address for billing contact.
`address_contact_number`	[string] Phone number for billing contact.
`address_street_1`	[string] Billing address.
`address_street_2`	[string] Billing address.
`address_town`	[string] Town or city.
`address_county`	[string] Country or state.
`address_state`	[string] State.
`address_post_code`	[string] Postal code.
`address_country`	[string] Country name.
`address_note`	[string] Additional notes for billing address.
`address_default`	[string] Indicates whether this is the default billing address (`0` = No, `1` = Yes). If set to `1`, this address will be used as the default billing address.

Shipping address object

Field	Description
`address_company`	[string] Company name for shipping.
`address_contact_name`	[string] Contact name for shipping.
`address_contact_email`	[string] Email address for shipping contact.
`address_contact_number`	[string] Phone number for shipping contact.
`address_street_1`	[string] Shipping address.
`address_street_2`	[string] Shipping address.
`address_town`	[string] Town or city
`address_county`	[string] Country or region.
`address_state`	[string] State.
`address_post_code`	[string] Postal code.
`address_country`	[string] Country name.
`address_note`	[string] Additional notes for shipping address.
`address_default`	[string] Indicates whether this is the default shipping address (`0` = No, `1` = Yes). If set to `1`, this address will be used as the default shipping address.


{
   "type": {
       "code": "trade"
   },
   "department": "UK",
   "title": "Intend Design Studio",
   "first_name": "",
   "last_name": "",
   "email": "intend@gmail.com",
   "credentials": {
       "username": "",
       "password": ""
   },
   "currency": "GBP",
   "tax_ref": {
       "code": "T1"
   },
   "detail": {
       "contact_number": "123 809 4674",
       "contact_person": "",
       "website": "https://intendsoftware.com/",
       "registration_number": "123456",
       "registration_address": "England",
       "company_number": "789546123",
       "eori_number": null,
       "vat_number": "12345555",
       "payment_term": "proforma"
   },
   "billing_address": {
       "address_company": "",
       "address_contact_name": "Clark Kent",
       "address_contact_email": "kent@gmail.com",
       "address_contact_number": "123 809 4674",
       "address_street_1": "Intend Design Studio",
       "address_street_2": "92a Penryn Avenue, Fishermead",
       "address_town": "Milton Keynes",
       "address_county": "Buckinghamshire",
       "address_post_code": "MK6 2BE",
       "address_country": "United Kingdom",
       "address_note": "",
       "address_default": "1"
   },
   "shipping_addresses": [
       {
          "address_company": "Intend Design Studio",
           "address_contact_name": "Clark Kent",
           "address_contact_email": "kent@gmail.com",
           "address_contact_number": "123 809 4674",
           "address_street_1": "Intend Design Studio",
           "address_street_2": "92a Penryn Avenue, Fishermead",
           "address_town": "Milton Keynes",
           "address_county": "Buckinghamshire",
           "address_post_code": "MK6 2BE",
           "address_country": "United Kingdom",
           "address_note": "",
           "address_default": "1"
       }
   ],
   "contacts": [],
   "source": "web",
   "source_status": "P"
}

Response

A successful request return HTTP 200 and includes the newly created client's client_id and client_account reference.

Field	Description
`status`	[integer] HTTP status code of the response.
`response`	[boolean] Indicates if the request was successful (`true` or `false`).
`data`	[object] Contains the client details returned by the API (see "Data object" below).
`msg`	[string] Response message describing the result of the request.

Data object

Field	Description
`client_id`	[integer] Client ID.
`client_account`	[string] Client account code.


{
   "status": 200,
   "response": true,
   "data": {
       "client_id": 30,
       "client_account": "INTEND01"
   },
   "msg": "Request Successful"
}