Invoice Registration

Registrera nya Invoices i Amili-systemet. Invoice Registration används för att skapa fakturor avsedda för distribution av Visma Amili, inklusive kundinformation, fakturadetaljer och rader.

Invoice Registration endpoints

• GET /invoice--registrations - Lista invoice registrations (pagerad)
• GET /invoice--registrations/{id} - Hämta en specifik invoice registration
• POST /invoice--registrations - Skapa en ny invoice registration

Se Case för att få åtkomst till registrerade cases.

Exempel Request

Nedan är ett exempel på att skapa en ny invoice registration. Andra operationer följer liknande request/response-mönster med samma datastruktur.

URL: POST /invoice--registrations

Headers:

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

Request Body:

{
  "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:

{
  "_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"
}

Parametrar

Request Body Properties

Property	Typ	Obligatorisk	Beskrivning
account	string	Ja	Account ID
creditor	string	Ja	Creditor ID
customer	object	Ja	Kundinformation
invoice_type	string	Ja	Typ av invoice (t.ex. "invoice")*
invoice_number	string	Ja	Fakturanummer från borgenär
reference_number	string	Nej	Referensnummer från borgenär
payout_reference	string	Nej	Referens för utbetalningsspårning
invoice_date	string	Ja	Datum när fakturan utfärdades (RFC 1123-format)
invoice_due_date	string	Ja	Förfallodatum för betalning (RFC 1123-format)
invoice_delivery_date	string	Nej	Datum när fakturan levererades (RFC 1123-format)
invoice_headline	string	Nej	Fakturarubriktext
invoice_body_text	string	Nej	Fakturatext
currency	string	Ja	Valutakod (för närvarande endast "SEK" stöds)
your_contact	string	Nej	Kontaktperson hos borgenär
your_reference	string	Nej	Referens från borgenär
our_reference	string	Nej	Referens från Amili
your_additional_reference	string	Nej	Ytterligare referensfält
order_reference	string	Nej	Orderreferens
contract_reference	string	Nej	Kontraktsreferens
debt_description	string	Nej	Beskrivning av skulden
letter_template	string	Nej	Brevmall (föråldrad 2025-06-13, inte längre obligatorisk)
custom_column_headlines	array	Nej	Anpassade kolumnrubriker för matrixartiklar
matrix	array	Ja	Array av fakturarader
preferred_invoice_distribution	string	Nej	Föredragen distributionsmetod*
case_settings	object	Nej	Case-specifika inställningar
labels	array	Nej	Array av etikettsträngar för kategorisering
file_import_report	object	Nej	Filimportmetadata (readonly)
start_flow	boolean	Nej	Om case-flödet ska startas omedelbart

Customer Properties

Property	Typ	Obligatorisk	Beskrivning
name	string	Ja	Kundens fullständiga namn
customer_number	string	Nej	Kundens referensnummer
id_number	string	Nej**	Personnummer eller organisationsnummer (valfritt vid registrering)
is_person	boolean	Nej***	Om kunden är en svensk person (utesluter is_company, is_foreign)
is_company	boolean	Nej***	Om kunden är ett svenskt företag (utesluter is_person, is_foreign)
is_foreign	boolean	Nej***	Om kunden är utländsk (utesluter is_person, is_company)
address	object	Nej	Kundens adressinformation
mobile_number	string	Nej	Kontakttelefonnummer
email	string	Nej	Kontakt-e-postadress
car_registration	object	Nej	Bilregistreringsdetaljer (utesluter customer_number)

Car Registration Properties

Property	Typ	Obligatorisk	Beskrivning
number	string	Ja	Bilregistreringsnummer
country	string	Nej	Bilens land (standard "SE")
ownership_date	string	Nej	Datum för ägarskapskontroll (RFC 1123-format, standard invoice_date)

Address Properties

Property	Typ	Obligatorisk	Beskrivning
address_line_1	string	Nej	Primär adressrad
address_line_2	string	Nej	Sekundär adressrad
address_line_3	string	Nej	Tertiär adressrad
zip_code	string	Nej	Postnummer
city	string	Nej	Stadnamn
country	string	Nej	Landskod i ISO 3166-1 alpha-2-format (t.ex. "SE")
gln	string	Nej	Global Location Number

Matrix Item Properties

Property	Typ	Obligatorisk	Beskrivning
article_number	string	Nej	Artikelidentifierare
article_description	string	Ja	Beskrivning av artikeln
unit_price	number	Nej	Pris per enhet
number_of_units	number	Nej	Antal enheter
total_price_excluding_vat	number	Ja	Totalt belopp före moms
unit_vat_percent	string	Nej	Momsprocent (t.ex. "25%", "12%", "6%", "0%"), standard "25%"
is_discount	boolean	Nej	Rabattflagga (visas inte på fakturan)
cost_center	string	Nej	Kostnadsställe (visas inte på fakturan)
article_date	string	Nej	Artikelförvärvsdatum (RFC 1123-format, visas inte på fakturan)
order_line_reference	string	Nej	Länkar till inköpsorderrad
custom_column_data	array	Nej	Array av anpassade kolumndatasträngar
extra_rows	array	Nej	Array av extra radsträngar

Response Properties

Property	Typ	Obligatorisk	Beskrivning
_id	string	Ja	Unik identifierare för registration
_created	string	Ja	Skapandetidsstämpel
_updated	string	Ja	Senaste uppdateringstidsstämpel
_etag	string	Ja	Entity tag för samtidighetskontroll
_status	string	Ja	Request-status (t.ex. "OK")*
_invoice	string	Ja	ID för skapad invoice
_case	string	Ja	ID för associerat case
_ocr_number	string	Ja	ID för OCR-nummer
ocr_number_ocr	string	Ja	OCR-nummer för betalningsreferens

*) För komplett lista över värden och detaljer, se Invoice Registration **) Valfritt vid registrering, men obligatoriskt för verkställighetstjänster ***) En av is_person, is_company eller is_foreign bör anges för att indikera kundtyp