Creditor

Hantera Creditor-information i Amili-systemet. Creditors representerar företag som använder Amili för faktura- och ärendehantering, inklusive deras organisationsdetaljer, adresser och konfigurationsinställningar. Creditors är alltid associerade med ett Account, och varje Account måste ha minst en Creditor. Den första Creditor för ett Account skapas under Account-skapande med parametern initial_creditor_data. Ytterligare Creditors kan skapas med denna endpoint.

Creditor endpoints

• GET /creditors - Lista alla creditors (pagerad)
• GET /creditors/{creditorId} - Hämta en specifik creditor
• POST /creditors - Skapa en ny creditor (Partner API)
• PATCH /creditors/{creditorId} - Uppdatera en creditor (Partner API)
• DELETE /creditors/{creditorId} - Ta bort en creditor (Partner API)

Exempel Request

Nedan är ett exempel på att hämta en specifik creditor.

URL: GET /creditors/674dbeb208847b9501cc9138

Headers:

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

Request Body: Ingen (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"
}

Parametrar

Path Parameters

Namn	Typ	Obligatorisk	Beskrivning
creditorId	string	Ja	Den unika identifieraren för creditor

Response Properties

Property	Typ	Obligatorisk	Beskrivning
_id	string	Ja	Unik identifierare för creditor
_created	string	Ja	Skapandetidsstämpel
_updated	string	Ja	Senaste uppdateringstidsstämpel
_etag	string	Ja	Entity tag för samtidighetskontroll
account	string	Ja	Account ID
name	string	Ja	Creditor-namn
description	string	Nej	Creditor-beskrivning
organization_no	string	Ja	Organisations-/företagsregistreringsnummer
creditor_number	number	Ja	Systemtilldelad Creditor-identifierare
is_active	boolean	Ja	Om Creditor är aktiv
standard_debt_description	string	Nej	Standardbeskrivning för skulder
always_use_standard_debt_description	boolean	Nej	Om standardbeskrivning alltid ska användas
agreement_address	object	Ja	Primär affärsadress
sender_address	object	Ja	Adress för att skicka korrespondens
invoice_address	object	Ja	Adress för fakturakorrespondens
case_config	object	Nej	Case-hanteringskonfiguration
payout_details	object	Yes	Bankkontouppgifter för utbetalningar
default_letter_locale	string	Nej	Standardspråk för brev (t.ex. "sv")*
added_to_erp_system	boolean	Nej	Om den har lagts till i ERP-system

Address Properties

Property	Typ	Obligatorisk	Beskrivning
address_line_1	string	Ja	Primär adressrad
zip_code	string	Ja	Postnummer
city	string	Ja	Stadnamn
country	string	Ja	Landskod i ISO 3166-1 alpha-2-format (t.ex. "SE")*

Case Config Properties

Property	Typ	Obligatorisk	Beskrivning
vat_area	string	Nej	Momsregion (t.ex. "sweden")*
commission_excluded_vat	boolean	Nej	Om kommission exkluderar moms
payout_capital_by_invoice	boolean	Nej	Om kapital ska betalas ut per faktura
payout_interest_by_invoice	boolean	Nej	Om ränta ska betalas ut per faktura
letter_config	object	Nej	Brevmallkonfiguration

Payout Details Properties

Property	Typ	Obligatorisk	Beskrivning
sek	object	Nej	SEK-valuta utbetalningsdetaljer

SEK Payout Properties

Property	Typ	Obligatorisk	Beskrivning
bankgiro	string	Ja	Bankgironummer för SEK-betalningar

*) För komplett lista över värden och detaljer, se Creditor