List Receipts

receipts.list_receipts() -> SyncCursorPage[ReceiptListReceiptsResponse]

GET/api/v2/public/orders/receipts

Goods receipts and their lines for all stores. receipt_type is required. Use from_id to page through them reliably.

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]

Number of receipts per page.

formatint32

page_start: Optional[int]

Page number, starting at 1.

formatint32

store_number: Optional[str]

Filter by store number.

to_id: Optional[int]

Filter up to this receipt ID.

formatint64

ReturnsExpand Collapse

class ReceiptListReceiptsResponse: …

A receipt order with its receipt lines.

datetime_created: datetime

When the order was created.

formatdate-time

datetime_expected: datetime

When the goods were expected to arrive.

formatdate-time

import_id: int

Identifier of the import the order arrived in.

formatint64

order_type_id: int

Type code for the order.

formatint32

updated_on: datetime

When the receipt was last changed.

formatdate-time

order_number: Optional[str]

Order the goods were received against.

receipt_lines: Optional[List[ReceiptLine]]

The lines on this receipt.

id: int

Identifier of the receipt line.

formatint64

purchase_price: float

Purchase price at the time of receipt.

formatdouble

received_quantity: float

Quantity actually received. A difference from shipped_quantity is a discrepancy.

formatdouble

shipped_quantity: float

Quantity the supplier said was sent.

formatdouble

store_products_price: float

Store price at the time of receipt.

formatdouble

updated_on: datetime

When the receipt was last changed.

formatdate-time

barcode: Optional[str]

Barcode for the product.

category_code: Optional[str]

Category the product belongs to.

container_barcode: Optional[str]

Barcode of the container the goods arrived in.

description: Optional[str]

Product name on the line.

group_code: Optional[str]

Group the product is ordered in.

line_number: Optional[int]

Position of the line within the receipt.

formatint32

product_number: Optional[str]

Product on the line.

status: Optional[str]

Current status of the receipt.

store_gln: Optional[str]

Global Location Number of the store.

store_number: Optional[str]

Store the goods were received in.

supplier_code: Optional[str]

Supplier the goods came from. Matches supplier_code on the suppliers endpoint.

supplier_name: Optional[str]

Supplier name.

List Receipts

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)

{
  "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"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

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"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}