Zobrazenie a vyhľadávanie faktúr
- V sandboxe
Jednoducho povedané
Kľúč klienta vidí faktúry vlastného klienta; operátor vidí faktúry všetkých klientov alebo jedného klienta cez client. Riadky nesú to, čo nesie GET /invoices/{id}, bez documents, a žiadny obsah faktúry: bez kupujúceho a súm
a bez dátumu vystavenia (pre Rumunsko a Poľsko z neho vyplýva deadline_at, s presnosťou na niekoľko dní). Neznámy parameter odpovie 400.
apiKeyAuthorizationBearer <token>Kľúč posielajte ako token typu Bearer: Authorization: Bearer <your-api-key>. Stav služby je jediné volanie, ktoré nevyžaduje kľúč.
q?stringČasť invoice_ref alebo čísla faktúry bez ohľadu na veľkosť písmen. Najviac 100 znakov.
length <= 100route?array<>Jeden alebo viac kanálov, oddelených čiarkou.
state?array<>Jeden alebo viac stavov, oddelených čiarkou.
client?stringFilter operátora na jedného klienta. Kľúč klienta môže uviesť len vlastného klienta; každý iný odpovie 404. Iný tvar odpovie 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$received_from?stringPrvý deň UTC, v ktorom faktúra prišla, vrátane.
datereceived_to?stringPosledný deň UTC, v ktorom faktúra prišla, vrátane.
datesort?stringPodľa času prijatia. Zhody sa rozhodnú podľa id, takže stránka sa medzi volaniami nepreusporiada.
"newest""newest""oldest"page?integer1 <= value1page_size?integer252550100200Jedna stránka zhôd.
application/json- response
data*array<>total*integerZhody pred rozdelením na stránky.
page*integerVrátená stránka. Stránka za koncom sa zníži na poslednú.
page_size*integercounts_by_state*Zhody podľa stavu so všetkými filtrami okrem state. Stav bez zhôd sa vynechá.
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 }}Prijaté a odmietnuté faktúry za deň a kanál GET
Vypočítané z úložiska pri každom volaní. received počíta faktúry podľa dňa UTC, v ktorom prišli; rejected počíta faktúry, ktoré sú teraz odmietnuté, podľa dňa UTC ich poslednej zmeny. Deň bez údajov má nuly, takže graf nemá medzery. Rozsah ako pri GET /invoices.
Podanie faktúry alebo dobropisu ako kanonického JSON POST
Služba hneď skontroluje dokument voči kanonickému modelu a predbežným kontrolám a pri zlyhaní ktorejkoľvek odpovie 422. Všetko ďalšie prebieha asynchrónne (zostavenie, oficiálna validácia, podanie na kanál, stavy) a oznamuje sa stavovými udalosťami. Opravené opätovné podanie odmietnutej faktúry používa rovnaký invoice_ref a nový Idempotency-Key; služba pokusy prepojí. V produkcii sa export z ERP prečíta len vtedy, keď nastavenia konektora klienta obsahujú vlastného predávajúceho a platbu, nie príklad z mapovania: inak odpovie 422 connector-settings-missing s uvedením, čo chýba. Sandbox ho číta s príkladom, ako predtým.