Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Lista fakturor

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

Anrop

HTTP GET till /invoices

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd/Datatyp

Default

id

nej

/invoices/32

ID till en faktura

ID

 

number

nej

number=1254

Fakturanummer utan prefix om sådant finnes

Sträng

 

companyid

nej(ja*)

companyid=1

Hämtar användarens fakturor kopplade till angivet bolag.

ID

Inloggad användares anläggnings bolag

state

nej

state=1

Hämtar användarens fakturor med angivet status

Heltal

Se status nedan

*Obligatioriskt om ett nummer anges

Exempel:

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

Svar

Tag

Format

Exempel

Förklaring

invoices

 

<invoices>

root-taggen som omsluter alla fakturor

invoice

 

<invoice>

Faktura

id

ID

<id>1044</id>

Unikt id

number

Sträng

<number>796</number>

Fakturanummer

prefix

Sträng

<prefix>F</prefix>

Fakturanummer prefix

orderedby

Sträng

Acme AB, Karl Anka

Faktura mottagaren.

totalamount

Heltal

99900

Fakturans totalbelopp i ören.

rest

Heltal

50000

Kvar att betala i ören.

invoicedate

Datum

2012-01-01

Fakturadatum.

duedate

Datum

2012-01-31

Förfallodatum.

payeddate

Datum

2012-01-28

Betaldag.

state

 

 

Status, se nedan.

number

Heltal

<number>2</number>

Status, se nedan.

value

Sträng

<value>Hos BGC</value>

Utläst status, se nedan.

reminderamount

Heltal

<reminderamount>2500</reminderamount>

Påminnelseavgift i ören

company

 

<company><id>1</id><name>Scrooge Inc.</name></company>

Bolaget som fakturan hör till 

<invoices>
  <invoice>
    <id>1044</id>
    <number>796</number>
    <prefix>F</prefix>
    <orderedby>Karl Anka</orderedby>
    <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>

Status

Se Fakturastatus för mer information om respektive status.

Värde

Namn

1

Ej skickad

2

Hos BGC

3

Klar

4

Påminnelse

5

Påminnelseservice

6

Inkasso

7

Skickad

8

Exporterad

  • No labels