v1

latestOpenAPI 3.1.02026-07-261450274.9 KB

Get Sales

Returns the list of company sales.

get/sales

Query parameters

pageinteger

Page number

branch_idsnumber[]

List of Location 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.

created_by_idsinteger[]

List of Employee IDs

client_idsinteger[]

List of Client (Person / Organization) IDs

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": 23097650,
      "id_label": "A026",
      "created_at": 1747750438000,
      "created_by_id": 206037,
      "client_id": 33775229,
      "warehouse_id": 3649247,
      "products": [
        {
          "title": "Ailun Glass Screen Protector for iPhone 11",
          "uom": {
            "id": 1,
            "description": "Pieces",
            "title": "pcs"
          },
          "amount": 1,
          "price": 10,
          "cost": 100
        }
      ]
    }
  ],
  "page": 1,
  "count": 30,
  "success": true
}