Skip to main content

Organisations

Because Hokodo focuses on B2B sales, the buyers on your platform will consist of Companies, who have employees, and those employees may be organised into teams or departments. Hokodo deals with this complexity through the concept of Organisations and Users.

  • A User is an individual employee at a company.
  • An Organisation is a group of Users who are all able to see or take action on that company's orders on your platform.
  • Each Organisation must be associated with a Company.

Common configurations​

One Company, one Organisation​

In many cases the Company will just have a single Organisation, and any employees of the company (Users) will be members of that Organisation.

In this case, any one of those Users will be able to see or take actions on any of the company's orders on your platform. For example, if a member of the Organisation has set up a direct debit mandate, then any other member of that Organisation can make purchases using the mandate.

One Company, many Organisations​

In other cases (for larger companies), there may be several Organisations - perhaps one associated to each department in the company.

In this case, Users can only see the Orders associated with their Organisation.

One User in multiple Organisations​

It is also possible for a single user to be a member of several Organisations. For example, a company director may make purchases on behalf of several companies which he's a director of. In this case his User would be associated with each of those Organisations. The User, members of the organisation, can have different roles and permissions.

What are Organisations used for?​

The Organisation provides us with important information to:

  • notify the right users,
  • give the users the appropriate permissions,
  • let you pre-approve users for Deferred Payment,
  • display credit limits to users.

Typical Organisation API flow​

A typical API flow is to:

  1. Create an Organisation POST /v1/organisations
  2. Create a User POST /v1/users

The User and Organsation IDs can then be used to create Orders and request Payment Offers, which is the main API interaction of the checkout flow.

For an example API Flow that begins with User and Organisation creation, see the Core flow in the Postman Collection.

User roles within Organisations​

Users can have one of the following roles in an organisation:

  • read-only user can only see resources attached to the Organisation (useful for an accountant for example).
  • member has the rights of a read-only user and can also get Deferred Payments.
  • admin has the rights of a member user and can also add members, remove members, or change role of members of the Organisation.