Receipts

List Receipts

GET/api/v2/public/orders/receipts

List Store Receipts

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

ModelsExpand Collapse

ReceiptListReceiptsResponse object { datetime_created, datetime_expected, import_id, 9 more }

A receipt order with its receipt lines.

datetime_created: string

When the order was created.

formatdate-time

datetime_expected: string

When the goods were expected to arrive.

formatdate-time

import_id: number

Identifier of the import the order arrived in.

formatint64

order_type_id: number

Type code for the order.

formatint32

updated_on: string

When the receipt was last changed.

formatdate-time

order_number: optional string

Order the goods were received against.

receipt_lines: optional array of object { id, purchase_price, received_quantity, 10 more }

The lines on this receipt.

id: number

Identifier of the receipt line.

formatint64

purchase_price: number

Purchase price at the time of receipt.

formatdouble

received_quantity: number

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

formatdouble

shipped_quantity: number

Quantity the supplier said was sent.

formatdouble

store_products_price: number

Store price at the time of receipt.

formatdouble

updated_on: string

When the receipt was last changed.

formatdate-time

barcode: optional string

Barcode for the product.

category_code: optional string

Category the product belongs to.

container_barcode: optional string

Barcode of the container the goods arrived in.

description: optional string

Product name on the line.

group_code: optional string

Group the product is ordered in.

line_number: optional number

Position of the line within the receipt.

formatint32

product_number: optional string

Product on the line.

status: optional string

Current status of the receipt.

store_gln: optional string

Global Location Number of the store.

store_number: optional string

Store the goods were received in.

supplier_code: optional string

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

supplier_name: optional string

Supplier name.

ReceiptListStoreReceiptsResponse object { datetime_created, datetime_expected, import_id, 9 more }

A receipt order with its receipt lines.

datetime_created: string

When the order was created.

formatdate-time

datetime_expected: string

When the goods were expected to arrive.

formatdate-time

import_id: number

Identifier of the import the order arrived in.

formatint64

order_type_id: number

Type code for the order.

formatint32

updated_on: string

When the receipt was last changed.

formatdate-time

order_number: optional string

Order the goods were received against.

receipt_lines: optional array of object { id, purchase_price, received_quantity, 10 more }

The lines on this receipt.

id: number

Identifier of the receipt line.

formatint64

purchase_price: number

Purchase price at the time of receipt.

formatdouble

received_quantity: number

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

formatdouble

shipped_quantity: number

Quantity the supplier said was sent.

formatdouble

store_products_price: number

Store price at the time of receipt.

formatdouble

updated_on: string

When the receipt was last changed.

formatdate-time

barcode: optional string

Barcode for the product.

category_code: optional string

Category the product belongs to.

container_barcode: optional string

Barcode of the container the goods arrived in.

description: optional string

Product name on the line.

group_code: optional string

Group the product is ordered in.

line_number: optional number

Position of the line within the receipt.

formatint32

product_number: optional string

Product on the line.

status: optional string

Current status of the receipt.

store_gln: optional string

Global Location Number of the store.

store_number: optional string

Store the goods were received in.

supplier_code: optional string

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

supplier_name: optional string

Supplier name.