Kundereskontro

Introduksjon

Kundereskontroen brukes til å holde orden på saldo for en enkelt kunde.

Når du lager en faktura på f.eks. 100 kroner, legges det inn en transaksjon av typen INVOICE på 100 kroner. Når kunden senere betaler, legges det inn en innbetalingstransaksjon av typen PAYMENT på -100 kroner. Ved å summere alle transaksjoner i kundereskontroen, kan du derfor se hva kunden til enhver tid skylder.

Alle beløp i kundetransaksjonene er inklusive eventuell merverdiavgift.

Fortegn på beløp

  • positive beløp er alltid i din favør
  • negative beløp er alltid i kundens favør.

.

Transaksjonstyper

Dette er de transaksjonstypene som brukes i Fakturo API:

transaction_type Forklaring
INVOICE Transaksjon for fakturabeløp
CREDIT_NOTE Transaksjon for kreditnotabeløp
OVERDUE_CHARGE Transaksjon for purregebyr
INTEREST Transaksjon for forsinkelsesrenter.
PAYMENT Transaksjon for en innbetaling (på faktura)/utbetaling (på kreditnota) du har registrert selv.
OCR Transaksjon for en innbetaling med KID-nummer (automatisk registert)

Eksempel på en transaksjonshistorikk

Nedenfor ser du et eksempel på en transaksjonshistorikk for en faktura:

id transaction_type Beløp Dato Forklaring
1 INVOICE 250,00 25. juli Opprinnelig faktura på 250 kroner.
2 CREDIT_NOTE -100,00 28. juli Laget kreditnota på 100 kroner.
3 OVERDUE_CHARGE 61,00 14. aug Kunden ble purret med purregebyr
4 PAYMENT -150,00 20. aug Kunden betalte 150 kroner
5 OVERDUE_CHARGE -61,00 1. sept Du tilbakeførte purregebyret

Hente transaksjonsliste

GET /api/v1/ar_transactions

Respons:

<?xml version="1.0" encoding="utf-8"?>
<ar_transactions page="1" total_pages="1" per_page="1000">
  <ar_transaction uri="https://app.fakturo.no/api/v1/ar_transaction/580">
    <transaction_date>2011-07-01</transaction_date>
    <amount>-3500.00</amount>
    <transaction_type>PAYMENT</transaction_type>
    <invoice uri="https://app.fakturo.no/api/v1/invoice/651"/>
  </ar_transaction>
  <ar_transaction uri="https://app.fakturo.no/api/v1/ar_transaction/579">
    <transaction_date>2011-06-30</transaction_date>
    <amount>-180.00</amount>
    <transaction_type>CREDIT_NOTE</transaction_type>
    <invoice uri="https://app.fakturo.no/api/v1/invoice/700"/>
  </ar_transaction>
  <ar_transaction uri="https://app.fakturo.no/api/v1/ar_transaction/578">
    <transaction_date>2011-06-30</transaction_date>
    <amount>492.23</amount>
    <transaction_type>INTEREST</transaction_type>
    <invoice uri="https://app.fakturo.no/api/v1/invoice/666"/>
  </ar_transaction>
  ...
</ar_transactions>

Url-parametere

Du kan filtrere transaksjonslisten på datoer og transaksjonstype:

URL-parameter Forklaring
transaction_type Filtrer på en av transaksjonstypene nevnt i tabellen over.
from_date Filtrer på transaksjonsdato fra og med denne datoen (format: yyyy-mm-dd)
to_date Filtrer på transaksjonsdato til og med denne datoen (format: yyyy-mm-dd)

Eksempel:

GET /api/v1/ar_transactions?transaction_type=PAYMENT&from_date=2011-01-01

Vise transaksjonsdetaljer

GET /api/v1/ar_transaction/:id

Respons:

<?xml version="1.0" encoding="utf-8"?>
<ar_transaction uri="https://app.fakturo.no/api/v1/ar_transaction/574">
  <transaction_date>2011-06-24</transaction_date>
  <amount>-16675.00</amount>
  <comment></comment>
  <from_account_number>1234.56.78901</from_account_number>
  <transaction_type>OCR</transaction_type>
  <invoice uri="https://app.fakturo.no/api/v1/invoice/687"/>
</ar_transaction>

URL i invoice-elementet peker til den fakturaen transaksjonen er knyttet til.

Lag ny innbetaling på faktura

En innbetaling må alltid knyttes til en faktura eller kreditnota. For en faktura brukes følgende URL:

POST /api/v1/invoice/:id/ar_transactions

med følgende input:

<ar_transaction>
  <amount>-100.00</amount>  <!--  merk: negativt beløp for innbetaling -->
  <transaction_date>2011-05-22</transaction_date>
  <comment>Innbetaling registrert via API</comment>
</ar_transaction>

Respons OK:

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

Lag ny utbetaling på kreditnota

For å legge inn en utbetaling på en kreditnota brukes følgende URL:

POST /api/v1/credit_note/:id/ar_transactions

med følgende input:

<ar_transaction>
  <amount>100.00</amount>  <!--  merk: positivt beløp for utbetaling -->
  <transaction_date>2011-05-22</transaction_date>
  <comment>Utbetaling registrert via API</comment>
</ar_transaction>

Oppdatere innbetaling

Ikke tilgjengelig

Slette innbetaling

DELETE /api/v1/ar_transaction/:id

Du kan bare slette innbetalinger som er registrert manuelt (dvs transaction_type = PAYMENT)

Opp til toppen av siden