invoices

Lista fakturor

Listar en eller flera fakturor för autentiserad användare.

Anrop

HTTP GET till /invoices

Parametrar

*Obligatoriskt om ett nummer anges

Exempel:

APIURL/invoices.xml?apikey=338934897438&state=6

Svar

<invoices>
  <invoice>
    <id>1044</id>
    <number>796</number>
    <prefix>F</prefix>
    <orderedby>Karl Anka</orderedby>
	<orderedbycustomerid>23</orderedbycustomerid>
    <totalamount>17000</totalamount>
    <rest>17000</rest>
    <invoicedate>2012-01-11</invoicedate>
    <duedate>2012-01-21</duedate>
    <payeddate/>
    <state>
      <number>2</number>
      <value>Hos BGC</value>
    </state>
    <reminderamount>2500</reminderamount>
    <company>
      <id>1</id>
      <name>Scrooge Inc.</name>
    </company>
  </invoice>
  <invoice>
     ...
  </invoice>
</invoices>

Skapa faktura

Skapar en faktura för autentiserad användare. Det finns tre alternativ:

1. Skapa fakturan och sätt den som "Ej skickad"
2. Skapa fakturan och skicka den med e-post
3. Skapa fakturan och skicka den med "central print", se Fakturadistribution

Anrop

HTTP POST till /invoices

Parametrar

*Obligatioriskt om "distributionmethod" anges.

Viktigt angående fakturadistribution. 

• Läs först Fakturadistribution för att se vad BRP stödjer och vad som behöver göras för att komma igång med fakturadistributionen.
• Om "distributionmethod" inte anges kommer fakturan att skapas och hamna i status 1 ("Ej Skickad"). Se info nedan om fakturastatus.
• Om "distributionmethod" anges kommer BRP försöka lägga upp fakturan för distribuering med vald metod. Går detta bra får fakturan status 9 ("Väntar på att skickas"). Går det inte bra får fakturan status 1 som ovan. 
• För "distributionmethod=email" krävs att beställaren har en giltig e-post adress samt att ett id till en rapportmall ("templateid") anges. Id:t finns i BRP under "Rapportmallar" 
• För "distributionmethod=centralprint21grams" krävs att beställaren har en giltig adress.   
• Fakturan kommer att hanteras av den schemalagda aktiviteten "Fakturadistribution" som försöker skicka fakturan. När den skickats ändras status till "Skickad", detta syns även i fakturans historik (Se Faktura-dialogen > fliken "Historik"). Skulle något gå fel med utskicket sätts status på fakturan tillbaka till 1 ("Ej Skickad") med ett felmeddelande på fakturans historikflik. 

Exempel:

APIURL/invoices.xml?apikey=338934897438&orderid=66

Svar

Samma som vid "Lista fakturor".  

Status

Se Fakturastatus för mer information om respektive status.
"Number" är konstant. Däremot är "Value" dynamiskt beroende på locale och det kan även ändras över tid. Betydelsen ändras dock aldrig dvs "Number"=1 betyder alltid en faktura som inte är skickad, oavsett hur man språkligt uttrycker det i "Value". Använd Number och håll en egen lista med språkuttryck på er sida.