List invoices

GET/api/v1/invoices

This endpoint allows you to list all invoices associated with the authenticated user. You can use optional query parameters to filter the results based on specific criteria.

Request attributes

Attribute	Type	Description
page	integer	The page number to retrieve.
response_code	integer	The PEPPOL response code of the invoice.
buyer_tin	string	The buyer tax identification number.
buyer_country_code	string	The buyer's country code (ISO 3166-1:Alpha2). ISO 3166-1:Alpha2 Country codes
is_locked	boolean	Only show invoices that can or cannot be edited.
issue_date_from	string	Filter invoice that were issued after (Y-m-d)
issue_date_to	string	Filter invoice that were issued before (Y-m-d)
created_date_from	string	Filter invoice that were created after (Y-m-d)
created_date_to	string	Filter invoice that were created before (Y-m-d)

Example Request

Request example with cURL

curl -G https://sandbox-peppol.oxygen.gr/api/v1/invoices \
  -H "Authorization: Bearer {token}" \
  -d page=2

Example Response

Response example

{
  "data": [
    {
      "id": "01kev9gvvrwggfmbjb3zg4qvb3"
      // The rest of the fields
    },
    {
      "id": "01kev9gvwbdc08j5gj3cdkbezy"
      // The rest of the fields
    }
  ],
  "links": {
    "first": "https://sandbox-peppol.oxygen.gr/api/v1/invoices?page=1",
    "last": "https://sandbox-peppol.oxygen.gr/api/v1/invoices?page=2",
    "prev": "https://sandbox-peppol.oxygen.gr/api/v1/invoices?page=1",
    "next": null
  },
  "meta": {
    "current_page": 2,
    "from": 16,
    "last_page": 2,
    "links": [
      {
        "url": "https://sandbox-peppol.oxygen.gr/api/v1/invoices?page=1",
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://sandbox-peppol.oxygen.gr/api/v1/invoices?page=1",
        "label": "1",
        "active": false
      },
      {
        "url": "https://sandbox-peppol.oxygen.gr/api/v1/invoices?page=2",
        "label": "2",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://sandbox-peppol.oxygen.gr/api/v1/invoices",
    "per_page": 15,
    "to": 17,
    "total": 17
  }
}