Skip to content
Colleqtive Developer
Get started
API Reference
Receipts

Retrieves a paginated list of receipt orders with receipt lines.

receipts.list_receipts(ReceiptListReceiptsParams**kwargs) -> SyncCursorPage[ReceiptListReceiptsResponse]
GET/api/v2/public/orders/receipts

Retrieves a paginated list of receipt orders with receipt lines.

ParametersExpand Collapse
receipt_type: int

The receipt type (required).

formatint32
from_id: Optional[int]

Filter from this receipt ID.

formatint64
is_submitted: Optional[bool]

Filter by submission status.

last_modified_date: Optional[Union[str, datetime]]

Filter by last modified date.

formatdate-time
order_number: Optional[str]

Filter by order number.

page_size: Optional[int]

The number of records per page.

formatint32
page_start: Optional[int]

The page number to start from.

formatint32
store_number: Optional[str]

Filter by store number.

to_id: Optional[int]

Filter up to this receipt ID.

formatint64
ReturnsExpand Collapse
class ReceiptListReceiptsResponse: …
order_number: str

The order number.

store_number: str

The store number.

datetime_created: Optional[datetime]

The datetime the order was created.

formatdate-time
datetime_expected: Optional[datetime]

The expected delivery datetime.

formatdate-time
import_id: Optional[int]

The import identifier.

formatint64
order_type_id: Optional[int]

The order type identifier.

formatint32
receipt_lines: Optional[List[ReceiptLine]]

The receipt lines for this order.

id: Optional[int]

The receipt line ID.

formatint64
barcode: Optional[str]

The product barcode.

category_code: Optional[str]

The product category code.

container_barcode: Optional[str]

The container barcode.

description: Optional[str]

A description of the line.

group_code: Optional[str]

The group code.

line_number: Optional[int]

The line number.

formatint32
product_number: Optional[str]

The product number.

received_quantity: Optional[float]

The quantity received.

formatdouble
shipped_quantity: Optional[float]

The quantity shipped.

formatdouble
updated_on: Optional[datetime]

When the line was last updated.

formatdate-time
status: Optional[str]

The order status.

store_gln: Optional[str]

The store GLN.

supplier_code: Optional[str]

The supplier code.

supplier_name: Optional[str]

The supplier name.

Retrieves a paginated list of receipt orders with receipt lines.

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
page = client.receipts.list_receipts(
    receipt_type=0,
)
page = page.list[0]
print(page.import_id)
{
  "list": [
    {
      "order_number": "DEL-2025-001",
      "store_number": "STORE001",
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "receipt_lines": [
        {
          "id": 1001,
          "barcode": "8710400000123",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "Organic Milk 1L",
          "group_code": "group_code",
          "line_number": 1,
          "product_number": "PRD-001",
          "received_quantity": 22,
          "shipped_quantity": 24,
          "updated_on": "2019-12-27T18:11:19.117Z"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "supplier_code": "SUP-042",
      "supplier_name": "Acme Wholesale BV"
    }
  ],
  "next_page": 0,
  "page_size": 0,
  "page_start": 0,
  "previous_page": 0,
  "total_count": 0
}
Returns Examples
{
  "list": [
    {
      "order_number": "DEL-2025-001",
      "store_number": "STORE001",
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "receipt_lines": [
        {
          "id": 1001,
          "barcode": "8710400000123",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "Organic Milk 1L",
          "group_code": "group_code",
          "line_number": 1,
          "product_number": "PRD-001",
          "received_quantity": 22,
          "shipped_quantity": 24,
          "updated_on": "2019-12-27T18:11:19.117Z"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "supplier_code": "SUP-042",
      "supplier_name": "Acme Wholesale BV"
    }
  ],
  "next_page": 0,
  "page_size": 0,
  "page_start": 0,
  "previous_page": 0,
  "total_count": 0
}