POST
Create a client account
Organization space User accounts only For: Administrator Conditions
  • Only the owner of the organization (the member recorded as its owner) can create a client account.
  • name, currency_code and currency_exponent are required.
  • The name must be unique among the client accounts of the organization, compared in lowercase.
  • currency_code is trimmed, converted to uppercase and must be 3 characters; currency_exponent is an integer from 0 to 6.
  • The logo must be an image of type jpeg, png, jpg, gif or svg, at most 2048 KB.
What else happens
  • The new client is created active.
  • Its own accounting books are opened (chart, journals and fiscal year) in the client’s space, in the given currency.
  • The creator becomes a member of the client and receives its administrator role and profile.
Part of Client accounts.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, organization_id, name, tax_registration_number, business_registration_number, address, city, country, logo_url, currency_code, currency_exponent, is_active, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource (only with response=resource).

id

Identifier of the client account (27-character KSUID string).

organization_id

Identifier of the organization the record belongs to.

name

Name of the client account, stored in lowercase.

tax_registration_number

Tax registration number of the client account; null when not set.

business_registration_number

Business registration number of the client account; null when not set.

address

Street address of the client account; null when not set.

city

City of the client account; null when not set.

country

Country of the client account as free text; null when not set.

logo_url

Public URL of the stored logo image, or null when no logo is set.

currency_code

3-character currency code of the client account, chosen when the client was created; it cannot be changed through this update.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

is_active
boolean

Whether the client account is active. An organization turns it on or off with the activate and deactivate actions.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).