Invoice Registration

Register new invoices in the Amili system. Invoice registration is used for creating invoices intended for distribution by Visma Amili, including customer information, invoice details, and line items.

Invoice Registration endpoints

GET /invoice--registrations - List invoice registrations (paginated)
GET /invoice--registrations/{id} - Get a specific invoice registration
POST /invoice--registrations - Create a new invoice registration

See Case for accessing registered cases.

Example Request

Below is an example of creating a new invoice registration. Other operations follow similar request/response patterns with the same data structure.

URL: POST /invoice--registrations

Headers:

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

Request Body:

json

{
  "customer": {
    "name": "Jane Doe",
    "customer_number": "12345",
    "id_number": "556789-1234",
    "is_person": true,
    "address": {
      "address_line_1": "Business Street 456",
      "zip_code": "54321",
      "city": "Gothenburg"
    },
    "mobile_number": "+46709876543",
    "email": "jane.doe@domain.se"
  },
  "account": "674dbeaf08847b9501cc9132",
  "creditor": "674dbeb208847b9501cc9138",
  "invoice_type": "invoice",
  "invoice_number": "INV-2024-002",
  "reference_number": "REF002",
  "payout_reference": "PAY002",
  "invoice_date": "Wed, 21 Jan 2024 10:11:22 GMT",
  "invoice_delivery_date": "Wed, 21 Jan 2024 10:11:22 GMT",
  "invoice_due_date": "Wed, 31 Jan 2024 10:11:22 GMT",
  "invoice_headline": "Consulting Services",
  "invoice_body_text": "Thank you for your business",
  "currency": "SEK",
  "your_contact": "Contact Person",
  "your_reference": "YOUR-REF-001",
  "our_reference": "OUR-REF-001",
  "debt_description": "Professional consulting services",
  "matrix": [
    {
      "article_description": "Consulting hours",
      "unit_price": 500,
      "total_price_excluding_vat": 500,
      "unit_vat_percent": "0%"
    }
  ]
}

Response Code: 201 Created

Response Body:

json

{
  "_updated": "Fri, 04 Jul 2025 08:20:41 GMT",
  "_created": "Fri, 04 Jul 2025 08:20:41 GMT",
  "_etag": "62d5a25b98fa0523ac22e81c09eb1f78d3a1dab9",
  "_id": "68678ed98d8dc95ece12793f",
  "_status": "OK",
  "_invoice": "68678ed98d8dc95ece12793f",
  "_case": "68678eda88b9226bb78d7169",
  "_ocr_number": "68678eda8d8dc95ece127944",
  "ocr_number_ocr": "20251855102634171529"
}

Parameters

Request Body Properties

Property	Type	Required	Description
`account`	string	Yes	Account ID
`creditor`	string	Yes	Creditor ID
`customer`	object	Yes	Customer information
`invoice_type`	string	Yes	Type of invoice (e.g. "invoice")*
`invoice_number`	string	Yes	Invoice number from creditor
`reference_number`	string	No	Reference number from creditor
`payout_reference`	string	No	Reference for payout tracking
`invoice_date`	string	Yes	Date invoice was issued (RFC 1123 format)
`invoice_due_date`	string	Yes	Due date for payment (RFC 1123 format)
`invoice_delivery_date`	string	No	Date invoice was delivered (RFC 1123 format)
`invoice_headline`	string	No	Invoice headline text
`invoice_body_text`	string	No	Invoice body text
`currency`	string	Yes	Currency code (currently only "SEK" supported)
`your_contact`	string	No	Contact person at creditor
`your_reference`	string	No	Reference from creditor
`our_reference`	string	No	Reference from Amili
`your_additional_reference`	string	No	Additional reference field
`order_reference`	string	No	Order reference
`contract_reference`	string	No	Contract reference
`debt_description`	string	No	Description of the debt
`letter_template`	string	No	Letter template (deprecated 2025-06-13, no longer required)
`custom_column_headlines`	array	No	Custom column headers for matrix items
`matrix`	array	Yes	Array of invoice line items
`preferred_invoice_distribution`	string	No	Preferred distribution method*
`case_settings`	object	No	Case-specific settings
`labels`	array	No	Array of label strings for categorization
`file_import_report`	object	No	File import metadata (readonly)
`start_flow`	boolean	No	Whether to start the case flow immediately

Customer Properties

Property	Type	Required	Description
`name`	string	Yes	Customer's full name
`customer_number`	string	No	Customer's reference number
`id_number`	string	No**	Personal ID or organization number (optional at registration)
`is_person`	boolean	No***	Whether the customer is a Swedish person (excludes is_company, is_foreign)
`is_company`	boolean	No***	Whether the customer is a Swedish company (excludes is_person, is_foreign)
`is_foreign`	boolean	No***	Whether the customer is foreign (excludes is_person, is_company)
`address`	object	No	Customer's address information
`mobile_number`	string	No	Contact phone number
`email`	string	No	Contact email address
`car_registration`	object	No	Car registration details (excludes customer_number)

Car Registration Properties

Property	Type	Required	Description
`number`	string	Yes	Car registration number
`country`	string	No	Country of the car (defaults to "SE")
`ownership_date`	string	No	Date for ownership check (RFC 1123 format, defaults to invoice_date)

Address Properties

Property	Type	Required	Description
`address_line_1`	string	No	Primary address line
`address_line_2`	string	No	Secondary address line
`address_line_3`	string	No	Tertiary address line
`zip_code`	string	No	Postal code
`city`	string	No	City name
`country`	string	No	Country code in ISO 3166-1 alpha-2 format (e.g. "SE")
`gln`	string	No	Global Location Number

Matrix Item Properties

Property	Type	Required	Description
`article_number`	string	No	Article identifier
`article_description`	string	Yes	Description of the item
`unit_price`	number	No	Price per unit
`number_of_units`	number	No	Number of units
`total_price_excluding_vat`	number	Yes	Total amount before VAT
`unit_vat_percent`	string	No	VAT percentage (e.g. "25%", "12%", "6%", "0%"), defaults to "25%"
`is_discount`	boolean	No	Discount flag (not shown on invoice)
`cost_center`	string	No	Cost center (not shown on invoice)
`article_date`	string	No	Article acquisition date (RFC 1123 format, not shown on invoice)
`order_line_reference`	string	No	Links to purchase order line
`custom_column_data`	array	No	Array of custom column data strings
`extra_rows`	array	No	Array of extra row strings

Response Properties

Property	Type	Required	Description
`_id`	string	Yes	Unique identifier for the registration
`_created`	string	Yes	Creation timestamp
`_updated`	string	Yes	Last update timestamp
`_etag`	string	Yes	Entity tag for concurrency control
`_status`	string	Yes	Request status (e.g. "OK")*
`_invoice`	string	Yes	ID of created invoice
`_case`	string	Yes	ID of associated case
`_ocr_number`	string	Yes	ID of OCR number
`ocr_number_ocr`	string	Yes	OCR number for payment reference

*) For complete list of values and details, please see Invoice Registration **) Optional at registration, but required for enforcement services ***) One of is_person, is_company, or is_foreign should be specified to indicate customer type

Invoice Registration ​