Receipts

List Receipts

receipts.list_receipts() -> SyncCursorPage[ReceiptListReceiptsResponse]

GET/api/v2/public/orders/receipts

List Store Receipts

receipts.list_store_receipts(, ) -> SyncCursorPage[ReceiptListStoreReceiptsResponse]

GET/api/v2/public/stores/{store_number}/orders/receipts

ModelsExpand 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.

class ReceiptListStoreReceiptsResponse: …

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.