An organisation is the root administrative object for a client. Each partner client has a single organisation. Each organisation must have a unique Partner Client Id. Only one organisation may exist per Partner Client Id. Each organisation also receives a unique Crezco ID.
- `organisationId` string, uuid —Unique ID of the organisation in Crezco. Set by Crezco. Ignored when sent as part of a Create or an Update
- `partnerClientId` string, required —Unique ID of the client in the partner system. This is the unique ID of the client that owns the organisation in your system. Each organisation must have a unique Partner Client Id.
- `companiesHouseNumber` string —Company Registration Number (CRN) of the UK company as registered with companies house. This is a unique code that Companies House uses to help it quickly and correctly identify a company. A CRN is assigned upon incorporation, which means that limited companies and LLPs (limited liability partnerships) must have one.
Some other types of business do not require a CRN because they are not incorporated and are not required to file their statutory records with Companies House. Types of business not requiring a CRN include sole traders and general partnerships.
CRNs are always 8 characters long. These can be either 8 digits or 2 letters followed by 6 digits.
- `companyName` string — Name of the company that this organisation represents - `users` UserResourceRepresentationVersion4[], required —Collection of Users that belong to this organisation. Each organisation must have at least one User with the "Admin" role.
When submitting a PUT request for an organisation, any users which exist in Crezco but are not included in this collection will be marked as inactive. Any users which exist in this collection but not in Crezco will be created.
- `userId` string, uuid, nullable —Unique ID for this user in Crezco. This field is required when updating an existing user. Omitting this field will cause a new user to be created.
- `email` string —Email address for this User. The email addresses do not need to be globally unique but must be unique within the context of each individual request, irrespective of case sensitivity.
- `firstName` string, required —First name of this user. Where a user has multiple first names or middle names include them all in this field.
- `lastName` string, required — Last name (surname) of this user. - `role` string, required —The role that this user holds within the organisation. See our documentation for a list of acceptable roles
- `active` boolean —Is this user active within Crezco? All organisations must have at least one active user with the Admin role.
- `features` string[] — Collection of features that are enabled for this organisation - `verification` OrganisationVerificationStatusOverviewResourceRepresentationVersion4 - `verified` boolean, required — Indicates whether the organisation is verified. - `verifiable` boolean, required — Indicates whether the organisation is eligible to enter/re-enter the verification process. - `status` 'Unknown' | 'NotStarted' | 'InProgress' | 'Completed' | 'Failed', required - `promotions` OrganisationPromotionResourceRepresentationVersion4[] — Promotions associated to the organisation - `promotionId` string — The unique identifier for the promotion. - `validFromUtc` string, date-time — Indicates when the promotion will be valid from. - `validToUtc` string, date-time — Indicates when the promotion will be valid to. ## Response `201` Created - OrganisationResourceRepresentationVersion4 —An organisation is the root administrative object for a client. Each partner client has a single organisation. Each organisation must have a unique Partner Client Id. Only one organisation may exist per Partner Client Id. Each organisation also receives a unique Crezco ID.
- `organisationId` string, uuid —Unique ID of the organisation in Crezco. Set by Crezco. Ignored when sent as part of a Create or an Update
- `partnerClientId` string, required —Unique ID of the client in the partner system. This is the unique ID of the client that owns the organisation in your system. Each organisation must have a unique Partner Client Id.
- `companiesHouseNumber` string —Company Registration Number (CRN) of the UK company as registered with companies house. This is a unique code that Companies House uses to help it quickly and correctly identify a company. A CRN is assigned upon incorporation, which means that limited companies and LLPs (limited liability partnerships) must have one.
Some other types of business do not require a CRN because they are not incorporated and are not required to file their statutory records with Companies House. Types of business not requiring a CRN include sole traders and general partnerships.
CRNs are always 8 characters long. These can be either 8 digits or 2 letters followed by 6 digits.
- `companyName` string — Name of the company that this organisation represents - `users` UserResourceRepresentationVersion4[], required —Collection of Users that belong to this organisation. Each organisation must have at least one User with the "Admin" role.
When submitting a PUT request for an organisation, any users which exist in Crezco but are not included in this collection will be marked as inactive. Any users which exist in this collection but not in Crezco will be created.
- `userId` string, uuid, nullable —Unique ID for this user in Crezco. This field is required when updating an existing user. Omitting this field will cause a new user to be created.
- `email` string —Email address for this User. The email addresses do not need to be globally unique but must be unique within the context of each individual request, irrespective of case sensitivity.
- `firstName` string, required —First name of this user. Where a user has multiple first names or middle names include them all in this field.
- `lastName` string, required — Last name (surname) of this user. - `role` string, required —The role that this user holds within the organisation. See our documentation for a list of acceptable roles
- `active` boolean —Is this user active within Crezco? All organisations must have at least one active user with the Admin role.
- `features` string[] — Collection of features that are enabled for this organisation - `verification` OrganisationVerificationStatusOverviewResourceRepresentationVersion4 - `verified` boolean, required — Indicates whether the organisation is verified. - `verifiable` boolean, required — Indicates whether the organisation is eligible to enter/re-enter the verification process. - `status` 'Unknown' | 'NotStarted' | 'InProgress' | 'Completed' | 'Failed', required - `promotions` OrganisationPromotionResourceRepresentationVersion4[] — Promotions associated to the organisation - `promotionId` string — The unique identifier for the promotion. - `validFromUtc` string, date-time — Indicates when the promotion will be valid from. - `validToUtc` string, date-time — Indicates when the promotion will be valid to. ## Other responses - `400` — Bad Request - `401` — You do not have access. Check your API key is correct. - `403` — You do not have access to this organisation. - `404` — Not Found - `406` — The version of the API that you requested is not available. Check your Crezco-Version header. If you omit this header you will use the latest version of the API. - `409` — Conflict - `429` — You have made too many requests to the API in too short a period. Wait a while and try again. --- [API](https://skmtc.net/crezco/apis/payables-api.md) · [All operations](https://skmtc.net/crezco/apis/payables-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crezco/payables-api/revisions/4427e79fba09/schema)