Creditor

Hantera borgenärsinformation i Amili-systemet. Borgenärer representerar företag som använder Amili för faktura- och ärendehantering, inklusive deras organisationsdetaljer, adresser och konfigurationsinställningar.

Borgenärer är alltid associerade med ett Konto, och varje Konto måste ha minst en Borgenär. Den första Borgenären för ett Konto skapas under Konto-skapandet med parametern initial_creditor_data. Ytterligare Borgenärer kan skapas med denna endpoint.

Viktiga noteringar:

• Aktiveringskrav: När is_active: true sätts blir flera fält obligatoriska: standard_debt_description, sender_address, invoice_address, och payout_details (med minst en valuta och kontotyp konfigurerad).
• POST-only-fält: Fälten account och agreement_template kan endast sättas när en borgenär skapas och kan inte ändras efteråt.
• Readonly-fält: Fält som partner, creditor_number, och added_to_erp_system hanteras automatiskt av systemet.
• Organisationsnummer: Använd antingen organization_no (för svenska företag) eller non_swedish_organization_no (för icke-svenska företag), men inte båda.

Creditor endpoints

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

Example Request

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

URL: GET /creditors/674dbeb208847b9501cc9138

Headers:

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

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

Parameters

Path Parameters

Name	Type	Required	Description
creditorId	string	Yes	Den unika identifieraren för borgenären

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unik identifierare för borgenären
_created	string	Yes	Tidsstämpel för skapande
_updated	string	Yes	Tidsstämpel för senaste uppdatering
_etag	string	Yes	Entity tag för samtidighetskontroll
account	string	Yes (POST only)	Konto-ID - kan endast sättas när en borgenär skapas
partner	string	No (readonly)	Partner-ID - sätts automatiskt från account.partner
name	string	Yes	Borgenärsnamn
company_name	string	No	Företagsnamn om det skiljer sig från borgenärsnamnet
description	string	No	Borgenärsbeskrivning
organization_no	string	Yes (or non_swedish_organization_no)	Svenskt organisationsnummer (10 siffror)
non_swedish_organization_no	string	Yes (or organization_no)	Icke-svenskt organisationsnummer (ömsesidigt uteslutande med organization_no)
vat_area	string	Yes	Momsområde (standard: "sweden")*
external_id	string	No	Identifierare från borgenärens eget system (unik per konto)
creditor_number	number	No (readonly)	Systemtilldelad borgenärsidentifierare
is_active	boolean	No (default: false)	Om borgenären är aktiv - när true, krävs aktiveringsfält nedan
standard_debt_description	string	Required when is_active is True	Standardbeskrivning för skulder
always_use_standard_debt_description	boolean	No (default: false)	Om standardbeskrivningen alltid ska användas
agreement_address	object	No	Primär företagsadress
sender_address	object	Required when is_active is True	Adress för att skicka korrespondens
invoice_address	object	Required when is_active is True	Adress för fakturakorrespondens
case_config	object	No	Konfiguration för ärendehantering (åsidosätter account case_config)
case_settings	object	No	Standardinställningar för ärenden för borgenär (åsidosätter account case_settings)
flow_config	object	No	Oföränderliga flödesparametrar för ärendets livscykel (åsidosätter account flow_config)
invoice_config	object	No	Konfiguration för fakturanummerhantering
settings	object	No	Borgenärsspecifika inställningar (utbetalningsexporter, ärendeinfoexporter, etc.)
payout_details	object	Required when is_active is True	Bankkontodetaljer för utbetalningar (kan inte vara tom)
default_letter_locale	string	No (default: "sv")	Standardspråk för brev (t.ex. "sv")*
legal_type	string	No	Juridisk enhetstyp*
contact_information	object	No	Kontaktdetaljer (krävs om use_creditor_contact_information_on_letters är true)
logo_file	object	No	Logotypmediafil (endast PNG)
logo_details	object	No	Konfiguration för logotypvisning
kivra_sender_id	string	No	Kivra-integrations avsändar-ID
solicitor_team	string	No	Referens till inkassolag
agreement_template	string	No (POST only)	Avtalsmall-ID (åsidosätter account agreement_template)
productification	string	No	Referens till produktifiering
delay_print_distribution_hours	number	No	Timmar att fördröja utskriftsdistribution (0-24) för förhandsgranskning
offboarding	boolean	No	Om borgenären håller på att avvecklas
added_to_erp_system	boolean	No (readonly, default: false)	Om tillagd i ERP-system
added_to_distributor_system	object	No (readonly)	Datum när borgenären registrerades i distributörssystem
company_status	object	No	Aktuell företagsstatusinformation
company_status_history	array	No (readonly)	Historiska företagsstatusposter
offboarding_details	object	No (readonly)	Avvecklingsstatus och datum

Address Properties

Property	Type	Required	Description
address_line_1	string	Yes	Primär adressrad
zip_code	string	Yes	Postnummer
city	string	Yes	Stadsnamn
country	string	Yes	Landskod i ISO 3166-1 alpha-2 format (t.ex. "SE")*

Case Config Properties

Property	Type	Required	Description
vat_area	string	No	Momsområde (t.ex. "sweden")*
commission_excluded_vat	boolean	No	Om provision exkluderar moms
payout_capital_by_invoice	boolean	No	Om kapital ska betalas ut per faktura
payout_interest_by_invoice	boolean	No	Om ränta ska betalas ut per faktura
letter_config	object	No	Konfiguration för brevmallar

Payout Details Properties

Objektet payout_details innehåller bankkontoinformation organiserad per valuta. Minst en valuta måste vara konfigurerad, och varje valuta måste ha minst en kontotyp specificerad. Objektet kan inte vara tomt när det tillhandahålls.

Property	Type	Required	Description
sek	object	No	SEK-valuta utbetalningsdetaljer (minst en av: bankgiro, plusgiro, etc.)
nok	object	No	NOK-valuta utbetalningsdetaljer
eur	object	No	EUR-valuta utbetalningsdetaljer
dkk	object	No	DKK-valuta utbetalningsdetaljer
usd	object	No	USD-valuta utbetalningsdetaljer
gbp	object	No	GBP-valuta utbetalningsdetaljer

Currency Payout Account Types

Varje valutaobjekt kan innehålla en eller flera av följande kontotyper (minst en måste tillhandahållas):

Property	Type	Required	Description
bankgiro	string	No	Bankgironummer (svenskt format)
plusgiro	string	No	Plusgironummer (svenskt format)
iban_bic	object	No	IBAN- och BIC-detaljer (se IBAN/BIC Properties nedan)
bank_account_number	object	No	Konto- och clearingnummer (se Bank Account Properties)

IBAN/BIC Properties

Property	Type	Required	Description
iban	string	Yes	IBAN-nummer
bic	string	Yes	BIC/SWIFT-kod

Bank Account Number Properties

Property	Type	Required	Description
account_number	string	Yes	Bankkontonummer
clearing_number	string	Yes	Clearingnummer

Example payout_details with multiple account types:

{
  "payout_details": {
    "sek": {
      "bankgiro": "12312312",
      "plusgiro": "123123-4"
    },
    "eur": {
      "iban_bic": {
        "iban": "SE3550000000054910000003",
        "bic": "ESSESESS"
      }
    },
    "nok": {
      "bank_account_number": {
        "account_number": "12345678901",
        "clearing_number": "9710"
      }
    }
  }
}

Validation Rules

POST-only-fält:

• account - Kan endast sättas när en borgenär skapas (POST), kan inte ändras via PATCH
• agreement_template - Kan endast sättas när en borgenär skapas (POST), kan inte ändras via PATCH

Readonly-fält:

• partner - Sätts automatiskt från account.partner via kaskaduppdatering
• creditor_number - Systemtilldelad unik identifierare
• added_to_erp_system - Systemhanterad flagga
• added_to_distributor_system - Systemhanterade datum
• company_status_history - Spåras automatiskt
• offboarding_details - Systemhanterad avvecklingsstatus

Ömsesidig uteslutning:

• organization_no och non_swedish_organization_no är ömsesidigt uteslutande - tillhandahåll det ena eller det andra, inte båda

Villkorliga krav (när is_active är True): När en borgenär aktiveras (is_active: true), blir följande fält obligatoriska:

• standard_debt_description - Standardtext för skuldbeskrivning
• sender_address - Adress för utgående korrespondens
• invoice_address - Adress för fakturarelaterad korrespondens
• payout_details - Minst en valuta med minst en kontotyp måste vara konfigurerad

Unikhetsbegränsningar: Kombinationen av följande fält måste vara unik (med valfria nycklar):

• partner
• account
• name
• company_name
• external_id

Ytterligare validering:

• organization_no måste vara exakt 10 siffror (svenskt format)
• payout_details kan inte vara ett tomt objekt när det tillhandahålls
• delay_print_distribution_hours måste vara mellan 0 och 24
• logo_file måste endast vara PNG-format
• vat_area är som standard "sweden" om det inte specificeras

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