Invoice
Access registered invoices in the Amili system.
Invoice endpoints
GET /invoices- List all invoices (paginated)GET /invoices/{id}- Get a specific invoice
See Invoice Registration for creating new invoices.
Example Request
Below is an example of retrieving a specific invoice. Other operations follow similar request/response patterns with the same data structure.
URL: GET /invoices/68678ed98d8dc95ece127944
Headers:
x-api-key: {your_access_token}Response Code: 200 OK
Response Body:
json
{
"_id": "68b006fd76535aeb5be09163",
"account": "671a133fc9e282cfad3ffeb6",
"creditor": "60e7fdefc90dc3e2ddd6c7ac",
"currency": "SEK",
"invoice_number": "F12345678",
"reference_number": "F12345678",
"payout_reference": "0123456789",
"letter_template": "invoices",
"matrix": [
{
"article_number": "123",
"article_description": "Description text",
"unit_vat_percent": "25%",
"unit_price": 300.0,
"number_of_units": 1,
"total_price_excluding_vat": 300.0
}
],
"invoice_date": "Sun, 30 Aug 2025 17:41:07 GMT",
"invoice_due_date": "Tue, 29 Sep 2025 17:41:07 GMT",
"invoice_type": "invoice",
"total_amount_including_vat": 375,
"total_amount_excluding_vat": 300.0,
"total_vat_25_percent": 75.0,
"total_vat_12_percent": 0,
"total_vat_6_percent": 0,
"total_vat": 75.0,
"amount_rounding": 0.0,
"increment_invoice_number": false,
"customer": "60e7fdefc90dc3e2ddd6c7ad",
"customer_name": "Jane Doe",
"customer_status": "initialized",
"agreement_version": "60e7fdefc90dc3e2ddd6c7ae",
"invoice_registration": "68b006fd76535aeb5be09164",
"creditor_name": "Integration Team AB",
"case": "68b006fd76535aeb5be09165",
"ocr_number": "68b006fd76535aeb5be09166",
"case_status": "invoice",
"case_state": "invoice",
"case_total_added_transaction_amount": 375.0,
"case_total_added_capital_amount": 375.0,
"case_total_added_interest_amount": 0,
"case_total_added_costs_amount": 0,
"case_total_remaining_transaction_amount": 375.0,
"case_total_remaining_capital_amount": 375.0,
"case_total_remaining_interest_amount": 0,
"case_total_remaining_costs_amount": 0,
"debtor": "68b006fd76535aeb5be09167",
"customer_id_number": "7755664433",
"debtor_name": "Jane Doe",
"print": "68b006fd76535aeb5be09168",
"print_document": {
"id": "8be4d5fc86d77d226b0f83f8593de423",
"filename": "8be4d5fc86d77d226b0f83f8593de423.pdf",
"content_type": "application/pdf",
"size": 27684
},
"_created": "Sun, 30 Aug 2025 17:32:55 GMT",
"_updated": "Sun, 30 Aug 2025 18:10:39 GMT",
"_etag": "e291a3c19b834a11960187af"
}Parameters
Response Properties
| Property | Type | Required | Description |
|---|---|---|---|
_id | string | Yes | Unique identifier for the invoice |
_created | string | Yes | Creation timestamp |
_updated | string | Yes | Last update timestamp |
_etag | string | Yes | Entity tag for concurrency control |
account | string | Yes | Account ID |
creditor | string | Yes | Creditor ID |
creditor_name | string | Yes | Name of the creditor |
customer | string | Yes | Customer ID |
customer_name | string | Yes | Name of the customer |
customer_id_number | string | Yes | Customer's personal ID or organization number |
customer_number | string | No | Customer's reference number |
customer_status | string | Yes | Current customer status (e.g. "initialized")* |
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 |
invoice_due_date | string | Yes | Due date for payment |
invoice_delivery_date | string | No | Date invoice was delivered |
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 |
debt_description | string | No | Description of the debt |
matrix | array | Yes | Array of invoice line items |
ocr_number | string | Yes | OCR number for payment reference |
case | string | Yes | Associated case ID |
case_status | string | Yes | Current case status (e.g. "invoice")* |
case_state | string | Yes | Current case state (e.g. "invoice")* |
agreement_version | string | Yes | Agreement version ID |
invoice_registration | string | Yes | Invoice registration ID |
print | string | No | Print document ID |
print_document | object | No | Print document information |
total_amount_including_vat | number | Yes | Total invoice amount including VAT |
total_amount_excluding_vat | number | Yes | Total invoice amount excluding VAT |
total_vat_25_percent | number | Yes | Total VAT amount at 25% |
total_vat_12_percent | number | Yes | Total VAT amount at 12% |
total_vat_6_percent | number | Yes | Total VAT amount at 6% |
total_vat | number | Yes | Total VAT amount |
amount_rounding | number | Yes | Rounding adjustment |
Customer Properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Customer's full name |
customer_number | string | No | Customer's reference number |
id_number | string | Yes | Personal ID or organization number |
is_person | boolean | Yes | Whether the customer is an individual |
address | object | Yes | Customer's address information |
mobile_number | string | No | Contact phone number |
email | string | No | Contact email address |
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 |
Matrix Item Properties
| Property | Type | Required | Description |
|---|---|---|---|
article_number | string | No | Article identifier |
article_description | string | Yes | Description of the item |
unit_price | number | Yes | Price per unit |
number_of_units | number | No | Quantity of items |
total_price_excluding_vat | number | Yes | Total amount before VAT |
unit_vat_percent | string | No | VAT percentage (e.g. "25%")* |
Print Document Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Document ID |
filename | string | Yes | Name of the file |
content_type | string | Yes | MIME type of the file |
size | number | Yes | File size in bytes |
*) For complete list of values and details, please see Invoice
