Kunder

Hente kundeliste

GET /api/v1/customers

Respons:

<?xml version="1.0" encoding="utf-8"?>
<customers page="1" total_pages="2" per_page="100">
  <customer uri="https://app.fakturo.no/api/v1/customer/9">
    <name1>Ola Nordmann Consulting ANS</name1>
    <name2>Ola Nordmann</name2>
    <address1>Gateadresseveien 1</address1>
    <address2></address2>
    <postal_code>9100</postal_code>
    <postal_name>KVALØYSLETTA</postal_name>
    <email>post@example.org</email>
    <customer_number></customer_number>
  </customer>
  <customer uri="https://app.fakturo.no/api/v1/customer/18">
    <name1>Kari Nordmann Consulting ANS</name1>
    <name2>Kari Nordmann</name2>
    <address1>Postboks 21209</address1>
    <address2></address2>
    <postal_code>1212</postal_code>
    <postal_name>TROLLÅSEN</postal_name>
    <email>info@example.org</email>
    <customer_number></customer_number>
  </customer>
  ...
</customers>

Url-parametere

Du kan søke i kundelisten ved å legge til en URL-parameter:

URL-parameter Forklaring
search Søker i name1, name2 eller email

Eksempel:

GET /api/v1/customers?search=Ola+Nordmann+Consulting+AS

Vise detaljer

GET /api/v1/customer/:id

Respons:

<?xml version="1.0" encoding="utf-8"?>
<customer uri="https://app.fakturo.no/api/v1/customer/9">
  <name1>Ola Nordmann Consulting ANS</name1>
  <name2>Ola Nordmann</name2>
  <address1>Gateadresseveien 1</address1>
  <address2></address2>
  <postal_code>9100</postal_code>
  <postal_name>KVALØYSLETTA</postal_name>
  <country_code>NO</country_code>
  <email>post@example.org</email>
  <customer_number></customer_number>
</customer>

Hente fakturaer sendt til en kunde

For å hente alle fakturaer sendt til en bestemt kunde, brukes følgende URL:

GET /api/v1/customer/:id/invoices

Hente kreditnotaer for en kunde

For å hente alle kreditnotaer sendt til en bestemt kunde, brukes følgende URL:

GET /api/v1/customer/:id/credit_notes

Hente inn/utbetalinger for en kunde

GET /api/v1/customer/:id/ar_transactions

Ny kunde

POST /api/v1/customers

med følgende input:

<customer>
  <name1>Ola Nordmann Consulting ANS</name1> 
  <name2>Ola Nordmann</name2>        <!--  valgfri -->
  <address1>Gateadresse 1</address1> <!--  valgfri -->
  <address2>Gateadresse 2</address2> <!--  valgfri -->
  <postal_code>0656</postal_code>            
  <postal_name>OSLO</postal_name>
  <country_code>NO</country_code>
  <email>test@example.org</email>    <!--  valgfri -->
</customer>

Respons OK:

201 Created med Location-header som er URL til den nye kunden som er opprettet.

Oppdatere kunde

PUT /api/v1/customer/:id

Input er de feltene du ønsker å oppdatere, eksempelvis:

<customer>
  <address1>Ny Gateadresse 1</address1> 
</customer>

Dersom oppdatering går bra, returneres oppdatert kundeobjekt.

Slette kunde

DELETE /api/v1/customer/:id

Du kan bare slette kunder som det ikke har blitt sendt fakturaer til.

Opp til toppen av siden