List Store Receipts

ReceiptListStoreReceiptsPageResponse Receipts.ListStoreReceipts(, )

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

Goods receipts and their lines for one store. Same as the organisation-wide receipts endpoint with a store filter. receipt_type is required.

ParametersExpand Collapse

ReceiptListStoreReceiptsParams parameters

required string storeNumber

The store number.

required Int receiptType

The receipt type (required).

formatint32

Long fromID

Filter from this receipt ID.

formatint64

Boolean isSubmitted

Filter by submission status.

DateTimeOffset lastModifiedDate

Filter by last modified date.

formatdate-time

string orderNumber

Filter by order number.

Int pageSize

Number of receipts per page.

formatint32

Int pageStart

Page number, starting at 1.

formatint32

Long toID

Filter up to this receipt ID.

formatint64

ReturnsExpand Collapse

class ReceiptListStoreReceiptsPageResponse:

Generic paginated response wrapper.

required Int PageSize

Maximum number of items returned per page.

formatint32

required Int PageStart

Current page number (1-based).

formatint32

required Long TotalCount

Total number of records matching the query across all pages.

formatint64

IReadOnlyList<ReceiptListStoreReceiptsResponse>? List

Collection of items for the current page.

required DateTimeOffset DatetimeCreated

When the order was created.

formatdate-time

required DateTimeOffset DatetimeExpected

When the goods were expected to arrive.

formatdate-time

required Long ImportID

Identifier of the import the order arrived in.

formatint64

required Int OrderTypeID

Type code for the order.

formatint32

required DateTimeOffset UpdatedOn

When the receipt was last changed.

formatdate-time

string? OrderNumber

Order the goods were received against.

IReadOnlyList<ReceiptLine>? ReceiptLines

The lines on this receipt.

required Long ID

Identifier of the receipt line.

formatint64

required Double PurchasePrice

Purchase price at the time of receipt.

formatdouble

required Double ReceivedQuantity

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

formatdouble

required Double ShippedQuantity

Quantity the supplier said was sent.

formatdouble

required Double StoreProductsPrice

Store price at the time of receipt.

formatdouble

required DateTimeOffset UpdatedOn

When the receipt was last changed.

formatdate-time

string? Barcode

Barcode for the product.

string? CategoryCode

Category the product belongs to.

string? ContainerBarcode

Barcode of the container the goods arrived in.

string? Description

Product name on the line.

string? GroupCode

Group the product is ordered in.

Int? LineNumber

Position of the line within the receipt.

formatint32

string? ProductNumber

Product on the line.

string? Status

Current status of the receipt.

string? StoreGln

Global Location Number of the store.

string? StoreNumber

Store the goods were received in.

string? SupplierCode

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

string? SupplierName

Supplier name.

IReadOnlyDictionary<string, JsonElement>? ListBody

Additional body-level metadata for the list.

IReadOnlyDictionary<string, IReadOnlyList<string>>? ListFilters

Active filter criteria applied to the result set, keyed by field name.

Int? NextPage

Next page number, or null when on the last page.

formatint32

Long? PreviousPage

Previous page number, or null when on the first page.

formatint64

string? ProjectLastModifiedDate

Last modified date/time of the project.

string? ScrollID

Opaque scroll identifier for deep-pagination scenarios.

string? ServerTime

Server UTC date/time when the response was generated.

string? SortColumn

Column name the results are sorted by.

string? SortOrder

Sort direction (asc or desc).

string? TaskLastModifiedDate

Last modified date/time of the task.

List Store Receipts

ReceiptListStoreReceiptsParams parameters = new()
{
    StoreNumber = "store_number",
    ReceiptType = 0,
};

var page = await client.Receipts.ListStoreReceipts(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

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