List of proforma invoices

Request

Returns the list of proforma invoices. Supports the Paging.

Security

shoptetAccessToken or shoptetPrivateApiToken

Query

isValidboolean

filtering according to document validity

Example:isValid=true

orderCodestring

filtering according to number of order.

Example:orderCode=2018000012

creationTimeFromstring

filtering items created after or same as requested datetime. ISO 8601 format ("2017-12-12T22:08:01+0100").

Example:creationTimeFrom=2017-02-28T17:04:47+0100

creationTimeTostring

filtering items created before or same as requested datetime. ISO 8601 format ("2017-12-12T22:08:01+0100")

Example:creationTimeTo=2017-02-28T17:04:47+0100

varSymbolstring

filtering according to variable symbol of proforma invoice

Example:varSymbol=666

itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 100.

Example:itemsPerPage=50

pageinteger

Page number to return. Default value is 1.

Example:page=3

Headers

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/proforma-invoices?isValid=true&orderCode=2018000012&creationTimeFrom=2017-02-28T17%3A04%3A47%2B0100&creationTimeTo=2017-02-28T17%3A04%3A47%2B0100&varSymbol=666&itemsPerPage=50&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

{
  "data": {
    "proformaInvoices": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}