Skip to content
Colleqtive Developer
Get started
API Reference
Receipts

Retrieves a paginated list of receipt orders for a specific store.

receipts.list_store_receipts(strstore_number, ReceiptListStoreReceiptsParams**kwargs) -> SyncCursorPage[ReceiptListStoreReceiptsResponse]
GET/api/v2/public/stores/{store_number}/orders/receipts

Retrieves a paginated list of receipt orders for a specific store.

ParametersExpand Collapse
store_number: str
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]
formatint32
page_start: Optional[int]
formatint32
to_id: Optional[int]

Filter up to this receipt ID.

formatint64
ReturnsExpand Collapse
class ReceiptListStoreReceiptsResponse: …

A receipt order with its receipt lines.

datetime_created: datetime
formatdate-time
datetime_expected: datetime
formatdate-time
import_id: int
formatint64
order_type_id: int
formatint32
updated_on: datetime
formatdate-time
order_number: Optional[str]
receipt_lines: Optional[List[ReceiptLine]]
id: int
formatint64
purchase_price: float
formatdouble
received_quantity: float
formatdouble
shipped_quantity: float
formatdouble
store_products_price: float
formatdouble
updated_on: datetime
formatdate-time
barcode: Optional[str]
category_code: Optional[str]
container_barcode: Optional[str]
description: Optional[str]
group_code: Optional[str]
line_number: Optional[int]
formatint32
product_number: Optional[str]
status: Optional[str]
store_gln: Optional[str]
store_number: Optional[str]
supplier_code: Optional[str]
supplier_name: Optional[str]

Retrieves a paginated list of receipt orders for a specific store.

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_store_receipts(
    store_number="store_number",
    receipt_type=0,
)
page = page.list[0]
print(page.import_id)
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "order_number": "order_number",
      "receipt_lines": [
        {
          "id": 0,
          "purchase_price": 0,
          "received_quantity": 0,
          "shipped_quantity": 0,
          "store_products_price": 0,
          "updated_on": "2019-12-27T18:11:19.117Z",
          "barcode": "barcode",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "description",
          "group_code": "group_code",
          "line_number": 0,
          "product_number": "product_number"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}
Returns Examples
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "order_number": "order_number",
      "receipt_lines": [
        {
          "id": 0,
          "purchase_price": 0,
          "received_quantity": 0,
          "shipped_quantity": 0,
          "store_products_price": 0,
          "updated_on": "2019-12-27T18:11:19.117Z",
          "barcode": "barcode",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "description",
          "group_code": "group_code",
          "line_number": 0,
          "product_number": "product_number"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}