Creditor

Manage creditor information in the Amili system. Creditors represent businesses that use Amili for invoice and case management, including their organization details, addresses, and configuration settings. Creditors are always associated with an Account, and each Account must have at least one Creditor. The first Creditor for an Account is created during Account creation using the initial_creditor_data parameter. Additional Creditors can be created using this endpoint.

Creditor endpoints

• GET /creditors - List all creditors (paginated)
• GET /creditors/{creditorId} - Get a specific creditor
• POST /creditors - Create a new creditor (Partner API)
• PATCH /creditors/{creditorId} - Update a creditor (Partner API)
• DELETE /creditors/{creditorId} - Delete a creditor (Partner API)

Example Request

Below is an example of retrieving a specific creditor.

URL: GET /creditors/674dbeb208847b9501cc9138

Headers:

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

Request Body: None (GET request)

Response Code: 200 OK

Response Body:

{
  "_id": "674dbeb208847b9501cc9138",
  "account": "674dbeaf08847b9501cc9132",
  "name": "Amili Integration Team",
  "organization_no": "1122334455",
  "is_active": true,
  "standard_debt_description": "Standard skuldbeskrivning på Konto",
  "agreement_address": {
    "address_line_1": "Redaregatan 50",
    "zip_code": "25236",
    "city": "Helsingborg",
    "country": "SE"
  },
  "case_config": {
    "vat_area": "sweden",
    "commission_excluded_vat": false,
    "payout_capital_by_invoice": true,
    "payout_interest_by_invoice": false,
    "letter_config": {}
  },
  "description": "Generella tester",
  "default_letter_locale": "sv",
  "payout_details": {
    "sek": {
      "bankgiro": "12312312"
    }
  },
  "sender_address": {
    "address_line_1": "Redaregatan 50",
    "zip_code": "25236",
    "city": "Helsingborg",
    "country": "SE"
  },
  "invoice_address": {
    "address_line_1": "Redaregatan 50",
    "zip_code": "25236",
    "city": "Helsingborg",
    "country": "SE"
  },
  "always_use_standard_debt_description": false,
  "added_to_erp_system": false,
  "_updated": "Fri, 04 Apr 2025 14:30:14 GMT",
  "_created": "Mon, 02 Dec 2024 14:05:38 GMT",
  "creditor_number": 2000037,
  "_etag": "9513f97705d5a98d99f5a61f483b4102c67f0ec6"
}

Parameters

Path Parameters

Name	Type	Required	Description
creditorId	string	Yes	The unique identifier of the creditor

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unique identifier for the creditor
_created	string	Yes	Creation timestamp
_updated	string	Yes	Last update timestamp
_etag	string	Yes	Entity tag for concurrency control
account	string	Yes	Account ID
name	string	Yes	Creditor name
description	string	No	Creditor description
organization_no	string	Yes	Organization/company registration number
creditor_number	number	Yes	System-assigned creditor identifier
is_active	boolean	Yes	Whether the creditor is active
standard_debt_description	string	No	Default description for debts
always_use_standard_debt_description	boolean	No	Whether to always use default description
agreement_address	object	Yes	Primary business address
sender_address	object	Yes	Address for sending correspondence
invoice_address	object	Yes	Address for invoice correspondence
case_config	object	No	Case handling configuration
payout_details	object	Yes	Bank account details for payouts
default_letter_locale	string	No	Default language for letters (e.g. "sv")*
added_to_erp_system	boolean	No	Whether added to ERP system

Address Properties

Property	Type	Required	Description
address_line_1	string	Yes	Primary address line
zip_code	string	Yes	Postal code
city	string	Yes	City name
country	string	Yes	Country code in ISO 3166-1 alpha-2 format (e.g. "SE")*

Case Config Properties

Property	Type	Required	Description
vat_area	string	No	VAT region (e.g. "sweden")*
commission_excluded_vat	boolean	No	Whether commission excludes VAT
payout_capital_by_invoice	boolean	No	Whether to pay out capital per invoice
payout_interest_by_invoice	boolean	No	Whether to pay out interest per invoice
letter_config	object	No	Letter template configuration

Payout Details Properties

Property	Type	Required	Description
sek	object	No	SEK currency payout details

SEK Payout Properties

Property	Type	Required	Description
bankgiro	string	Yes	Bankgiro number for SEK payments

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