Amili API

Här hittar du resurser som behövs för att implementera en integration med Amili API.

Hoppa direkt till API Documentation för detaljerade referenser om du vet vad du letar efter.

Om du är ny till API:et föreslår vi att du:

1. Läser Getting Started-sektionen, som ger enkla användningsfallbeskrivningar och kodexempel
2. Fortsätter med Common Concepts för att förstå autentisering, paginering och felhantering
3. Granskar Entity Relations för att förstå datamodellen
4. Tittar närmare på de mest centrala endpoints i API:et

Kom igång

Denna sektion ger en översikt över vanliga användningsfall som en integration troligen kommer att implementera. De centrala koncepten och kärnendpoints som beskrivs i API-referensen är sammanlänkade i en logisk sekvens för att ge en mer sammanhängande vy över API:et.

Se endpoint-referenserna för detaljerade beskrivningar av kärnendpoints och relaterade parametrar.

Vanliga användningsfall

Följande användningsfall beskriver typiska integrationsscenarion och deras implementeringssekvenser:

• Invoice Use Case - Beskriver sekvensen och implementationen för fakturaskapande, kreditering och avbokning
• Case Use Case - Beskriver sekvensen och implementationen för ärenderegistrering där gäldenären betalar hela beloppet innan ärendet skickas för inkasso

API-dokumentation

För kompletta API-specifikationer, se swagger-specifikationerna nedan. Du kan också ladda ner våra Postman-samlingar för att testa API-endpoints direkt.

Swagger-specifikation

• Partner API: https://api-sandbox.amili.se/docs/partner
• Creditor API: https://api-sandbox.amili.se/docs/creditor

Postman-samlingar

• Ladda ner Partner API Collection
• Ladda ner Creditor API Collection

Vanliga koncept

Innan du dyker in i specifika endpoints är det viktigt att förstå de vanliga koncepten som gäller för hela API:et. Detta inkluderar grundläggande aspekter som säkerhet, datahämtningsmönster, felhantering och integrationsmöjligheter. Att förstå dessa koncept hjälper dig att implementera vilken endpoint som helst effektivt och följa bästa praxis.

• Authentication
• Pagination and Queries
• Error Handling and Rate Limiting
• User Interface Integration

Endpoints

Följande endpoints utgör kärnan i API:et och möjliggör implementationen av centrala användningsfall.

Kärnentiteter

Entitet	Endpoint	Beskrivning
Partner	/partners	Hantera de affärsentiteter som kan hantera flera Creditors. Partners representerar systemintegratorer eller stora organisationer som hanterar flera Creditors.
Account	/accounts	Hantera affärsentiteter med sina egna inställningar, mallar och konfigurationer för att hantera Cases och avtal.
Creditor	/creditors	Hantera företag som använder Amili för faktura- och ärendehantering. En Creditor tillhör antingen en Partner eller ett Account.
Case	/cases	Få åtkomst till inkassoärenden med associerade fakturor, kundinformation och statusspårning.
Customer	/customers	Hantera individer eller organisationer associerade med Cases och Invoices, inklusive deras kontaktuppgifter och adressinformation.

Dataregistrering

Entitet	Endpoint	Beskrivning
Invoice Registration	/invoice--registrations	Registrera nya fakturor för distribution av Amili. Skapar fakturaposter och associerar dem eventuellt med Cases.
Case Registration	/case--registrations	Registrera nya Cases för inkassobearbetning. Skapar Cases och associerar dem med Customers och Invoices.

Filhantering

Entitet	Endpoint	Beskrivning
Media Upload	/media--upload	Ladda upp och bifoga filer till Cases, främst används för att bifoga originalfakturadokument till Cases.

Betalnings- och transaktionshantering

Entitet	Endpoint	Beskrivning
Creditor Payment	/creditor--payments	Registrera betalningar som gjorts direkt till Creditors mot specifika Cases eller Invoices.
Creditor Cancellation	/creditor--cancellations	Avboka aktiva Cases eller Invoices när de inte längre kräver bearbetning.
Creditor Crediting	/creditor--creditings	Utfärda krediteringar för Cases, hela fakturor eller delvisa fakturabelopp.
Finance Payout Specification	/finance--payout-specifications	Konfigurera och hantera hur insamlade medel betalas ut till Creditors, inklusive bankuppgifter och utbetalningsscheman.

Användarhantering

Entitet	Endpoint	Beskrivning
Users	/users	Hantera användaråtkomst till systemet. Users kan associeras med antingen Partners eller Accounts för att få åtkomst till deras respektive Creditors.