Docs

Popis i pretraga računa

  • U sandboxu

Jednostavnim riječima

Navodi i pretražuje račune jednog klijenta.
GET
/invoices

Ključ klijenta vidi račune svojeg klijenta; operater vidi račune svih klijenata ili jednog klijenta pomoću client. Retci nose ono što nosi GET /invoices/{id}, bez documents, i bez sadržaja računa: bez kupca ili iznosa, i bez datuma izdavanja (za Rumunjsku i Poljsku iz njega proizlazi deadline_at, s točnošću od nekoliko dana). Nepoznati parametar vraća 400.

Autorizacija

apiKey
headerAuthorizationBearer <token>

Ključ pošaljite kao bearer token: Authorization: Bearer <your-api-key>. Poziv za stanje usluge jedini je poziv za koji nije potreban ključ.

Parametri upita

q?string

Dio invoice_ref ili broja računa, bez razlikovanja velikih i malih slova. Najviše 100 znakova.

Duljinalength <= 100
route?array<>

Jedan ili više kanala, odvojenih zarezom.

state?array<>

Jedno ili više stanja, odvojenih zarezom.

client?string

Filtar operatera na jednog klijenta. Ključ klijenta smije navesti samo svojeg klijenta; svaki drugi vraća 404. Drugi oblik vraća 400.

Uzorak^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
received_from?string

Prvi UTC dan primitka računa, uključivo.

Formatdate
received_to?string

Zadnji UTC dan primitka računa, uključivo.

Formatdate
sort?string

Po vremenu primitka. Izjednačenja se razrješavaju po id-u, pa se stranica ne mijenja između poziva.

Zadano"newest"
Vrijednost iz"newest""oldest"
page?integer
Raspon1 <= value
Zadano1
page_size?integer
Zadano25
Vrijednost iz2550100200

Tijelo odgovora

Jedna stranica podudaranja.

application/json
  1. response
data*array<>
total*integer

Podudaranja prije straničenja.

page*integer

Vraćena stranica. Stranica iza kraja svodi se na zadnju.

page_size*integer
counts_by_state*

Podudaranja po stanju sa svim filtrima osim state. Stanje bez podudaranja izostavlja se.

curl -X GET "https://example.com/invoices" \  -H "Authorization: Bearer <your-api-key>"
{  "data": [    {      "id": "string",      "invoice_ref": "string",      "invoice_number": "string",      "route": "PEPPOL",      "environment": "sandbox",      "state": "received",      "legal_id": "string",      "buyer_status": "string",      "document_sha256": "string",      "attempts": [        {          "id": "string",          "state": "received",          "created_at": "2019-08-24T14:15:22Z"        }      ],      "errors": [        {          "code": "string",          "source": "string",          "message": "string",          "field": "string",          "fix_hint": "string",          "who_fixes": "us",          "related": [            {              "code": "string",              "source": "string"            }          ]        }      ],      "documents": [        {          "kind": "string",          "sha256": "string",          "href": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "deadline_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "page_size": 0,  "counts_by_state": {    "property1": 0,    "property2": 0  }}