Skip to main content
GET
/
invoices
List
curl --request GET \
  --url https://logistics.api.smartcp.org/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Client-Directory: <api-key>'
{
  "status": 200,
  "message": "OK",
  "data": {
    "invoices": [
      {
        "id": 1045,
        "nr": "FV/2026/05/1045",
        "type": "s",
        "status": "issued",
        "branch_id": 1,
        "issue_date": 1778457600,
        "service_date": 1778457600,
        "payment_term": 1779062400,
        "payment_date": null,
        "customer_name": "ACME Logistics",
        "customer_vat": "PL1234567890",
        "customer_country": "pl",
        "currency": "EUR",
        "amount_net": 1000,
        "amount_tax": 230,
        "amount_gross": 1230,
        "paid": 0,
        "left_to_pay": 1230,
        "orders": [
          {
            "type": "t",
            "nr": "Tour 4036230",
            "cmr": "CMR-2026-105",
            "tasks": [],
            "files": [],
            "contacts": []
          }
        ],
        "correct_of": null,
        "added_time": 1778486400
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 250,
      "total": 1,
      "total_pages": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Client API key sent as a bearer token.

​
X-Client-Directory
string
header
required

Client directory identifier. Legacy directory header is still accepted for backward compatibility.

Query Parameters

​
page
integer
default:1

Page number. Default: 1.

Required range: x >= 1
​
per_page
integer
default:250

Number of results per page. Default: 250, maximum: 500.

Required range: 1 <= x <= 500
​
period
enum<string>

Predefined date range filter.

Available options:
cur_month,
prev_month,
last_30_days,
last_60_days,
last_90_days,
custom
​
period_by
enum<string>

Invoice date field used together with period.

Available options:
added_date,
issue_date,
service_date,
payment_term,
payment_date
​
from
string<date>

Start date for period=custom in YYYY-MM-DD format.

​
to
string<date>

End date for period=custom in YYYY-MM-DD format.

​
type
string

Comma-separated invoice types. Available options: s - sales invoices, c - correcting invoices, p - purchase invoices.

Example:

"s,c"

​
status
string

Comma-separated invoice statuses. Available options: issued, paid, semipaid, overdue.

Example:

"issued,overdue"

​
branch
string

Comma-separated branch IDs.

Example:

"1,2"

​
customer
string

Comma-separated customer VAT numbers.

Example:

"PL1234567890,DE123456789"

​
customer_name
string

Partial customer name.

​
customer_country
string

Customer country code.

Example:

"pl"

​
nr
string

Search by invoice number, related order number, or invoice item text.

​
sort_by
enum<string>
default:issue_date

Sort field. Default: issue_date.

Available options:
issue_date,
service_date,
payment_term,
payment_date,
nr,
amount_gross,
amount_net,
amount_tax,
customer_name,
added_time
​
sort_dir
enum<string>
default:desc

Sort direction. Default: desc.

Available options:
asc,
desc

Response

Invoice list returned

​
status
integer
required
Example:

200

​
message
string
required
Example:

"OK"

​
data
object
required