Partner

Access partner information in the Amili system. Partners represent integrated business entities that can manage multiple creditors. Only available for Partner API.

Partner endpoints

• GET /partners - List all partners (paginated)
• GET /partners/{partnerId} - Get a specific partner

See Creditor for managing creditors associated with a partner.

Example Request

Below is an example of retrieving a specific partner. Other operations follow similar request/response patterns with the same data structure.

URL: GET /partners/618a851643314ff68dcb8895

Headers:

x-api-key: {your_access_token}
Content-Type: application/json

Request Body: None (GET request)

Response Code: 200 OK

Response Body:

{
  "_id": "618a851643314ff68dcb8895",
  "name": "Visma.net",
  "integration_id": "Visma.net",
  "description": "Visma.net - Integrated partner",
  "organization_no": "5565675906",
  "_updated": "Thu, 22 May 2025 16:04:30 GMT",
  "_created": "Tue, 09 Nov 2021 14:26:30 GMT",
  "_etag": "f0fa9d6056864307bf6cb060830fb9dc",
  "case_settings": {
    "interest_rate": {
      "reference_rate": true
    }
  }
}

Parameters

Path Parameters

Name	Type	Required	Description
partnerId	string	Yes	The unique identifier of the partner

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unique identifier for the partner
_created	string	Yes	Creation timestamp
_updated	string	Yes	Last update timestamp
_etag	string	Yes	Entity tag for concurrency control
name	string	Yes	Partner name
integration_id	string	Yes	Integration identifier
description	string	No	Partner description
organization_no	string	Yes	Organization/company registration number
case_settings	object	No	Case handling configuration

Case Settings Properties

Property	Type	Required	Description
interest_rate	object	No	Interest rate configuration

Interest Rate Properties

Property	Type	Required	Description
reference_rate	boolean	Yes	Whether to use reference rate

*) For complete list of values and details, please see Partner