Entities

Overview

Entities represent the customers of Monite API partners and can be either organizations or individuals (persons).

An entity registers its operations and stores financial documents (such as payables or bank transactions) via the partner’s applications. Those financial documents are in turn stored and processed by Monite.

Create an entity representing your customer

To create a new entity, call POST /entities. The entity can be either an organization or an individual:

1
curl -X POST 'https://api.sandbox.monite.com/v1/entities' \
2
     -H 'X-Monite-Version: 2024-05-25' \
3
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
4
     -H 'Content-Type: application/json' \
5
     -d '{
6
       "type": "organization",
7
       "email": "sales@example.com",
8
       "phone": "+4903023125000",
9
       "website": "https://example.com",
10
       "tax_id": "DE123456789",
11
       "address": {
12
         "country": "DE",
13
         "city": "Berlin",
14
         "state": "BE",
15
         "postal_code": "10115",
16
         "line1": "Flughafenstrasse 52"
17
       },
18
       "organization": {
19
         "legal_name": "Acme Inc.",
20
         "business_structure": "private_corporation"
21
       }
22
     }'

Explanation of the request fields:

• For organization entities:

  • business_structure - Required for EU and US entities to accept payments. Possible values:
    • EU: incorporated_partnership, private_corporation, public_corporation, unincorporated_partnership
    • US organizations: multi_member_llc, private_corporation, private_partnership, public_corporation, public_partnership, single_member_llc, sole_proprietorship, unincorporated_association

• For individual entities:

  • id_number - Required for Dutch individuals to accept payments. The person’s Burgerservicenummer (BSN) or Dutch Citizen Service Number.
  • ssn_last_4 - Required for US individuals to accept payments. The last four digits of the person’s Social Security Number (SSN).

A successful response returns the unique ID assigned to the created entity, along with the rest of the entity information:

1
{
2
  "id": "aea39c7e-630f-4664-a449-de899ebd4912",
3
  "created_at": "2022-04-21T14:23:01.691982+00:00",
4
  "updated_at": "2022-04-21T14:23:01.691994+00:00",
5
  ...
6
}

Notes:

• An entity’s country (address.country) cannot be changed after the entity has been created.

• US entities that wish to use payments must provide their phone number. It can be a US or international number.

• Spanish entities registered in the Canary Islands must use the country code IC instead of ES in their address.

  Spanish entities registered in Ceuta and Melilla must use the country code EA instead of ES.

• After an entity is created, you must also add its bank accounts.

• Entities can use Monite payment rails to accept and send payments. For this, the entity must be onboarded. Providing as much information as possible during the entity’s registration process will make the onboarding process smoother.

• To use payments, entities of the organization type must also add information of the legally responsible individuals associated with the organization. See the Persons page for details.

Entity tax ID and VAT ID

Monite requires at least one of tax ID or VAT ID specified for entities. Depending on the entity’s country and type (organization or individual), it may have both tax and VAT IDs or only one of them. In some countries, the tax ID is the same as VAT ID.

• If an entity provides a VAT ID, Monite considers this entity VAT-registered and applies the corresponding regulatory validations to invoices.
• If the entity is not VAT-registered, Monite expects that the entity provides its tax_id instead.
  • For organizations, tax_id can be the tax number or a similar business identifier.
  • For individuals, tax_id can be a government-issued identification number such as the taxpayer number, passport number, national ID, or similar.

Tax and VAT ID examples

Below are some examples of which values to provide in tax_id and VAT ID for various countries:

^* Liberian tax number needs to be specified as the entity’s VAT ID rather than as its tax_id.

Check if tax ID or VAT ID is required

Whether an entity’s tax ID and VAT ID are required on an invoice for it to be compliant depends on several factors, for example, the transaction type (e.g. B2B or B2C) or whether the sale is local or cross-border. Providing both the tax ID and VAT ID for entities (if available) helps reduce potential validation errors when issuing invoices.

Before creating an invoice, you can use GET /receivables/required_fields to check the requirements for a parcitular customer country and type:

GET /receivables/required_fields
  ? counterpart_country = <two-letter country code>
  & counterpart_type    = <organization | individual>

This endpoint returns invoice requirements for tax ID and VAT ID for the entity making the API call:

1
{
2
  ...
3
  "entity": {
4
    "tax_id": {
5
      "description": "...",
6
      "required": false
7
    },
8
    "vat_id": {
9
      "description": "...",
10
      "required": true
11
    }
12
  },
13
  ...
14
}

Upload entity logo

You can provide the entity logo for use in the PDF documents generated by the entity (such as Accounts Receivable invoices and credit notes). The logo will also appear on the payment page if the entity uses Monite payment rails.

The logo image can be PNG or JPG up to 10 MB in size.

To upload the logo for an entity, call PUT /entities/{entity_id}/logo with a multipart/form-data body containing the image in the file field:

1
curl -X PUT 'https://api.sandbox.monite.com/v1/entities/{entity_id}/logo' \
2
     -H 'X-Monite-Version: 2024-05-25' \
3
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
4
     -H 'Content-Type: multipart/form-data' \
5
     -F 'file=@logo.png;type=image/png'

The specified logo is stored on Monite servers, and the successful response returns the logo file information:

1
{
2
  "id": "c5f499a7-19ea-4057-9191-112da7effa31",
3
  "created_at": "2022-09-08T00:20:04.961397",
4
  "file_type": "entity-logo",
5
  "name": "upload",
6
  "region": "eu-central-1",
7
  "md5": "7537d5833741469a03162ce7a73bd4e8",
8
  "mimetype": "image/png",
9
  "url": "https://monite-file-saver-entity-logo-eu-central-1.s3.com/logo.png",
10
  "size": 1691,
11
  "previews": [],
12
  "pages": []
13
}

The logo file information will also returned in the logo response field when you retrieve entity information with GET /entities/{entity_id} or similar requests.

You can update the logo at any time later by uploading a new logo. You can also delete the logo by sending a DELETE request to the /entities/{entity_id}/logo.

List all entities

To get information about all the entities managed by the partner, call GET /entities. This endpoint supports the standard pagination, sorting, and filtering parameters.

Get a single entity

To get information about a specific entity, call GET /entities/{entity_id}:

1
curl 'https://api.sandbox.monite.com/v1/entities/c5f499a7-19ea-4057-9191-112da7effa31' \
2
  -H 'X-Monite-Version: 2024-05-25' \
3
  -H 'Authorization: Bearer ACCESS_TOKEN'

Update entity information

To update the details of an existing entity, call PATCH /entities/{entity_id}:

1
curl -X PATCH 'https://api.sandbox.monite.com/v1/entities/c5f499a7-19ea-4057-9191-112da7effa31' \
2
     -H 'X-Monite-Version: 2024-05-25' \
3
     -H 'Authorization: Bearer ACCESS_TOKEN' \
4
     -H 'Content-Type: application/json' \
5
     -d '{ "email": "info@example.com" }'

You can update all fields except address.country. The country of existing entities cannot be changed for regulatory reasons. The only way to change an entity’s country is to create a new entity.

Access the current user’s entity

If you use entity user tokens to authenticate Monite API requests, the following endpoints let you access the current user’s entity without providing its ID:

• GET /entity_users/my_entity - get entity information.
• PATCH /entity_users/my_entity - update entity information.

To use these endpoints, the entity user in question must have a role with the entity.read and entity.update permissions, respectively.