Skip to content

Invoice

Access registered invoices in the Amili system.

Invoice endpoints

See Invoice Registration for creating new invoices.

Examples

For working code examples and detailed usage guides, see Invoice Flow Examples.

For complete API specification with interactive testing, see Swagger: Invoice.

Parameters

Response Properties

PropertyTypeRequiredDescription
_idstringYesUnique identifier for the invoice
_createdstringYesCreation timestamp
_updatedstringYesLast update timestamp
_etagstringYesEntity tag for concurrency control
accountstringYesAccount ID
creditorstringYesCreditor ID
creditor_namestringYesName of the creditor
customerstringYesCustomer ID
customer_namestringYesName of the customer
customer_id_numberstringYesCustomer's personal ID or organization number
customer_numberstringNoCustomer's reference number
customer_statusstringYesCurrent customer status (e.g. "initialized")*
invoice_typestringYesType of invoice (e.g. "invoice")*
invoice_numberstringYesInvoice number from creditor
reference_numberstringNoReference number from creditor
payout_referencestringNoReference for payout tracking
invoice_datestringYesDate invoice was issued
invoice_due_datestringYesDue date for payment
invoice_delivery_datestringNoDate invoice was delivered
invoice_headlinestringNoInvoice headline text
invoice_body_textstringNoInvoice body text
currencystringYesCurrency code (currently only "SEK" supported)
your_contactstringNoContact person at creditor
your_referencestringNoReference from creditor
our_referencestringNoReference from Amili
debt_descriptionstringNoDescription of the debt
matrixarrayYesArray of invoice line items
ocr_numberstringYesOCR number for payment reference
casestringYesAssociated case ID
case_statusstringYesCurrent case status (e.g. "invoice")*
case_statestringYesCurrent case state (e.g. "invoice")*
agreement_versionstringYesAgreement version ID
invoice_registrationstringYesInvoice registration ID
printstringNoPrint document ID
print_documentobjectNoPrint document information
total_amount_including_vatnumberYesTotal invoice amount including VAT
total_amount_excluding_vatnumberYesTotal invoice amount excluding VAT
total_vat_25_percentnumberYesTotal VAT amount at 25%
total_vat_12_percentnumberYesTotal VAT amount at 12%
total_vat_6_percentnumberYesTotal VAT amount at 6%
total_vatnumberYesTotal VAT amount
amount_roundingnumberYesRounding adjustment

Customer Properties

PropertyTypeRequiredDescription
namestringYesCustomer's full name
customer_numberstringNoCustomer's reference number
id_numberstringYesPersonal ID or organization number
is_personbooleanYesWhether the customer is an individual
addressobjectYesCustomer's address information
mobile_numberstringNoContact phone number
emailstringNoContact email address

Address Properties

PropertyTypeRequiredDescription
address_line_1stringYesPrimary address line
zip_codestringYesPostal code
citystringYesCity name

Matrix Item Properties

PropertyTypeRequiredDescription
article_numberstringNoArticle identifier
article_descriptionstringYesDescription of the item
unit_pricenumberYesPrice per unit
number_of_unitsnumberNoQuantity of items
total_price_excluding_vatnumberYesTotal amount before VAT
unit_vat_percentstringNoVAT percentage (e.g. "25%")*
PropertyTypeRequiredDescription
idstringYesDocument ID
filenamestringYesName of the file
content_typestringYesMIME type of the file
sizenumberYesFile size in bytes

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