Get user invoice list

Request

Query Params

limit

integer

optional

Maximum number of results for given filters, default 25, maximum 100.

Example:

25

offset

integer

optional

The position number from which the results will be returned, numbered from 0, default 0.

Example:

0

filters[orderNumber]

string

optional

GK order number - please provide the exact number, after which the invoices for this order will appear on the list.

Example:

GK250526000055

filters[invoiceNumber]

string

optional

Invoice number - min. 3 characters.

filters[invoiceGroup]

string

optional

Document type group:
FVS - invoice for shipments, includes numbering FPRE, FVPR, FZOF, FZOD, FPRO
FVSZ - invoice for additional services
FKS - correction invoice

Example:

FVS

filters[paymentStatus]

string

optional

Invoice Payment Status:
ALL - all (default)
ONLY_NOT_PAID - only not fully settled
ONLY_PAID - only fully settled

Example:

ALL

filters[amountFrom]

number

optional

Minimum invoice amount, incl.
float|2 decimal points

Example:

12.99

filters[amountTo]

number

optional

Maximum invoice amount, incl.
float|2 decimal points

Example:

12.99

filters[saleDayFrom]

string <date>

optional

Lower range of the day of sale, incl.
date|format RRRR-MM-DD

Example:

2022-01-01

filters[saleDayTo]

string <date>

optional

Upper range of sales day, incl.
date|format RRRR-MM-DD

Example:

2022-12-31

Header Params

Accept-Language

string

optional

Example:

pl

X-Auth-Token

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://test.api.globkurier.pl/v1/user/invoices?limit=25&offset=0&filters[orderNumber]=GK250526000055&filters[invoiceNumber]&filters[invoiceGroup]=FVS&filters[paymentStatus]=ALL&filters[amountFrom]=12.99&filters[amountTo]=12.99&filters[saleDayFrom]=2022-01-01&filters[saleDayTo]=2022-12-31' \
--header 'Accept-Language: pl' \
--header 'X-Auth-Token;'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}