Customer

Få åtkomst till Customer-information i Amili-systemet. Customers representerar individer eller organisationer associerade med Cases och Invoices, inklusive deras kontaktuppgifter och adressinformation.

Customer endpoints

• GET /customers - Lista alla customers (pagerad)
• GET /customers/{customerId} - Hämta en specifik customer

Se Case Registration och Invoice Registration för att skapa customers.

Exempel Request

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

URL: GET /customers/cust_123456789

Headers:

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

Request Body: Ingen (GET request)

Response Code: 200 OK

Response Body:

{
  "_id": "cust_123456789",
  "name": "Jane Doe",
  "id_number": "202501012385",
  "is_person": true,
  "customer_number": "12345",
  "address": {
    "address_line_1": "Business Street 456",
    "zip_code": "54321",
    "city": "Gothenburg",
    "country": "SE"
  },
  "mobile_number": "+46709876543",
  "email": "jane.doe@domain.se",
  "is_active": true,
  "_created": "2025-01-01T10:00:00Z",
  "_updated": "2025-01-01T10:00:00Z"
}

Parametrar

Path Parameters

Namn	Typ	Obligatorisk	Beskrivning
customerId	string	Ja	Den unika identifieraren för customer

Query Parameters (Sök)

Namn	Typ	Obligatorisk	Beskrivning
id_number	string	Nej	Sök efter personnummer eller organisationsnummer
name	string	Nej	Sök efter kundnamn
email	string	Nej	Sök efter e-postadress

Response Properties

Property	Typ	Obligatorisk	Beskrivning
_id	string	Ja	Unik identifierare för customer
_created	string	Ja	Skapandetidsstämpel
_updated	string	Ja	Senaste uppdateringstidsstämpel
name	string	Ja	Kundens fullständiga namn
id_number	string	Ja	Personnummer eller organisationsnummer
is_person	boolean	Ja	Om kunden är en individ
customer_number	string	Nej	Kundens referensnummer
address	object	Ja	Kundens adressinformation
mobile_number	string	Nej	Kontakttelefonnummer
email	string	Nej	Kontakt-e-postadress
is_active	boolean	Ja	Om kunden är aktiv

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")*

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