Kreditnotaer

Generelt

En kreditnota brukes til å kreditere hele eller deler av en faktura som er sendt. Kreditnotaer tildeles fakturanummer i samme serie som fakturaene dine.

Hente liste av kreditnotaer

GET /api/v1/credit_notes

Respons:

<?xml version="1.0" encoding="utf-8"?>
<credit_notes page="1" total_pages="1" per_page="100">
  <credit_note uri="https://app.fakturo.no/api/v1/credit_note/675" status="not_paid">
    <invoice_number>118</invoice_number>
    <issue_date>2011-06-22</issue_date>
    <due_date/>
    <gross_amount>45457.50</gross_amount>
    <net_amount>36366.00</net_amount>
  </credit_note>
  <credit_note uri="https://app.fakturo.no/api/v1/credit_note/300" status="paid">
    <invoice_number>53</invoice_number>
    <issue_date>2011-03-22</issue_date>
    <due_date/>
    <gross_amount>180.00</gross_amount>
    <net_amount>144.00</net_amount>
  </credit_note>
</credit_notes>

Url-parametere

Du kan filtrere listen ved å legge til én eller flere URL-parametere:

URL-parameter Forklaring
search Søk på kreditnotanummer eller kreditnotamottakers navn.
from_date Fakturadato fra og med denne datoen (format: yyyy-mm-dd)
to_date Fakturadato til og med denne datoen (format yyyy-mm-dd)
status Filter på kreditnotastatus (se tabellen nedenfor for mulige verdier).

Eksempel:

GET /api/v1/credit_notes?search=Hansen&from_date=2011-01-01&to_date=2011-06-01

Filtrer på status

URL-parameteren status kan brukes til å bare hente ut kreditnotaer med en gitt status. Det kan være nyttig når du har mange kreditnotaer, og vet hvilke typer du ønsker returnert.

Verdiene som kan brukes er:

Filter Forklaring
all Alle kreditnotaer (samme som å ikke oppgi filter)
credit_note_sent Fakturaen er sendt, men ikke forfalt.
credit_note_paid Fakturaen er betalt

I tillegg til statusene over, kan du bruke meta-statuser som kombinerer flere av statusene over. Du vil ikke se disse

Filter Forklaring
overdue Alle fakturaer hvor enten fakturaen selv, purring eller inkassovarsel har forfalt.
waiting Alle fakturaer hvor enten faktura, purring eller inkassovarsel ikke har forfalt

Eksempel:

GET /api/v1/credit_notes?status=not_paid

Hente kreditnotadetaljer

For å hente alle detaljer om en enkelt kreditnota, bruker du:

GET /api/v1/credit_note/:id

I motsetning til en faktura, inneholder en kreditnota ingen purringer eller kreditnotaer. I stedet finner du en url til fakturaen som er kreditert (credited_invoice).

<?xml version="1.0" encoding="utf-8"?>
<credit_note uri="https://app.fakturo.no/api/v1/credit_note/682">
  <invoice_number>121</invoice_number>
  <issue_date>2011-06-24</issue_date>
  <due_date />
  <num_due_days>0</num_due_days>
  <gross_amount>49970.00</gross_amount>
  <net_amount>39976.00</net_amount>
  <comment></comment>
  <ocr_kid_number></ocr_kid_number>
  <recipient uri="https://app.fakturo.no/api/v1/customer/848">
    <name1>TestFirma AS</name1>
    <name2>Test Person</name2>
    <address1>Test Adresse 1</address1>
    <address2></address2>
    <postal_code>0656</postal_code>
    <postal_name>OSLO</postal_name>
    <email></email>
    <customer_number></customer_number>
    <country_code>NO</country_code>
  </recipient>
  <lines>
    <line index="1">
      <line_text>Gull, røkelse og myrra</line_text>
      <unit_price>19988</unit_price>
      <num_items>2</num_items>
      <discount_percent></discount_percent>
      <net_amount>39976.00</net_amount>
      <gross_amount>49970.00</gross_amount>
      <vat_rate percent="25">HIGH</vat_rate>
    </line>
  </lines>
  <shipments>
    <shipment type="original">
      <shipment_method>PAPER</shipment_method>
      <sent_at>2011-09-01 12:45:59</sent_at>
      <recipient>
        <name1>TestFirma a244d AS</name1>
        <name2>Test Person</name2>
        <address1>Test Adresse 1</address1>
        <address2></address2>
        <postal_code>0656</postal_code>
        <postal_name>OSLO</postal_name>
        <email>example@example.org</email>
        <customer_number></customer_number>
        <country_code>NO</country_code>
      </recipient>
    </shipment>
    <shipment type="copy">
      <shipment_method>EMAIL</shipment_method>
      <sent_at>2011-09-01 12:45:59</sent_at>
      <recipient>
        <email>kopi@example.org</email>
      </recipient>
    </shipment>
    <shipment type="copy">
      <shipment_method>EMAIL</shipment_method>
      <sent_at>2011-09-01 12:45:59</sent_at>
      <recipient>
        <email>kopi2@example.org</email>
      </recipient>
    </shipment>
  </shipments>
  <ar_transactions balance="-49970.00">
    <ar_transaction uri="https://app.fakturo.no/api/v1/ar_transaction/570">
      <transaction_date>2011-06-24</transaction_date>
      <amount>-49970.00</amount>
      <comment></comment>
      <from_account_number></from_account_number>
      <transaction_type>CREDIT_NOTE</transaction_type>
    </ar_transaction>
  </ar_transactions>
  <!-- URL til kreditert faktura -->
  <credited_invoice uri="https://app.fakturo.no/api/v1/invoice/681" />
</credit_note>

Lage og sende en kreditnota

POST /api/v1/invoice/:id/credit_notes

Input:

<credit_note>
  <shipments>
    <!--  shipment_method til hovedmottaker må alltid oppgis -->
    <shipment type="original">
      <shipment_method>PAPER</shipment_method> <!-- PAPER eller EMAIL -->
    </shipment>
  </shipments>
</credit_note>

Hvis alt går bra, returneres HTTP-responskoden 201 Created sammen med en Location-header som er URL til den nye kreditnotaen som er opprettet.

Denne metoden krediterer hele den opprinnelige fakturaen. Du kan foreløpig ikke kreditere en faktura delvis via APIet.

Kundedata hentes fra samme kundeobjekt som den opprinnelige fakturaen ble sendt til. Dersom du velger å sende som EMAIL, må kunden ha utfylt e-postadresse. Dersom du ønsker en annen adresse, må du først oppdatere kundens adresse ved å oppdatere kundeobjektet før kreditnotaen sendes.

Oppdatere en kreditnota

Ikke tilgjengelig

Du kan ikke oppdatere en kreditnota.

Slette en kreditnota

Ikke tilgjengelig

Du kan ikke slette en kreditnota.

Laste ned kreditnota som PDF

Du kan hente ned PDF-dokumentet for en kreditnota slik:

GET /api/v1/credit_note/:id/pdf

Dette metoden returnerer ikke XML, men i stedet binærdata som application/pdf.

Nedlasting av purringer og fakturaer gjøres på tilvarende måte, men med overdue_notice eller invoice i URLen i stedet for credit_note.

Opp til toppen av siden