v1

latestOpenAPI 3.1.02026-07-261450274.9 KB

Get Invoices

Retrieve a list of invoices.

get/invoices

Query parameters

pagenumber

Page number

legal_entity_idnumber

Legal entity ID

idsnumber[]

List of Invoice IDs

numbersstring[]

List of Invoice document numbers

payment_method'cash' | 'cashless' | 'credit_card'

Invoice payment method

statusesnumber[]

List of Invoice status IDs

client_idsnumber[]

List of Client (Person / Organization) IDs

payer_idsnumber[]

List of Payer IDs

managersnumber[]

List of Manager IDs

created_atstring[]

Filter by creation date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

modified_atstring[]

Filter by modification date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

issue_datestring[]

Filter by date of issue. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

due_datestring[]

Filter by due date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

sort'id' | '-id'

Defines the sorting order of returned results. Use a field name to sort ascending or prefix it with a minus sign (-) to sort descending.

Response

200

pageinteger

countinteger

successboolean

Example response

{
  "data": [
    {
      "id": 309859,
      "id_label": "023",
      "client": {
        "id": 31152179,
        "name": "Chris Jules",
        "first_name": "Chris",
        "last_name": "Jules",
        "email": "chrissy_jules14@gmail.com",
        "phone": [
          "4487645389"
        ],
        "modified_at": 1734549792000,
        "created_at": 1714652929000,
        "order_discount_services": 5,
        "sale_discount_services": 5,
        "custom_fields": {
          "f7757287": 968112000000
        },
        "ad_campaign": {
          "id": 349683,
          "name": "Friend"
        }
      },
      "payer": {
        "id": 31152179,
        "name": "Chris Jules",
        "first_name": "Chris",
        "last_name": "Jules",
        "email": "chrissy_jules14@gmail.com",
        "phone": [
          "4487645389"
        ],
        "modified_at": 1734549792000,
        "created_at": 1714652929000,
        "order_discount_services": 5,
        "sale_discount_services": 5,
        "custom_fields": {
          "f7757287": 968112000000
        },
        "ad_campaign": {
          "id": 349683,
          "name": "Friend"
        }
      },
      "status_full": {
        "id": 3319497,
        "name": "Paid",
        "color": "#5CB85C",
        "group": 10
      },
      "created_at": 1740480923000,
      "issue_date": 1740480920000,
      "due_date": 1743072920000,
      "products": [
        {
          "amount": 1,
          "id": 2847134,
          "order_id": 52100568,
          "price": 47.5,
          "title": "Delivery",
          "uom_id": 1,
          "type": 2,
          "service": true
        }
      ],
      "manager_id": 206037
    }
  ],
  "page": 1,
  "count": 23,
  "success": true
}