Receipts, receiving purchases

With "Receipts" you register received purchase orders.

Receipts can be linked to a specific purchase order or to a supplier to register received products from multiple purchase orders.

You can also receive products that are not on purchase orders. Picqer will then create a new purchase order with the products that are received that were not purchased.

Temporarily 2 active versions of receipts

There are temporarily 2 versions of receipts in Picqer while we change the core receipt functionality. This means API calls need to transition as well, and you’ll temporarily need to accommodate for requests and responses for both of these versions.

A user can change the version of a receipt on a per-receipt basis, which means you’ll have to support both versions simultaneously. Once a receipt has been created and at least one product is received, the version of that specific receipt cannot be changed anymore.

In short the changes for v2 receipts are:

• Products are added to the stock directly instead of upon completing the receipt
• The "receipt" resource changed
• Adding a product changed
• Expected products can be requested through a new endpoint
• Receipt products are immutable, but can be reverted through a new endpoint
• The following endpoints are not supported for v2 receipts
  • PUT https://example.picqer.com/api/v1/receipts/{idreceipt}/products/{idreceipt_product}
  • POST https://example.picqer.com/api/v1/receipts/{idreceipt}/mark-all-received

We expect to complete the roll-out of v2 receipts within a few months, after which we’ll discontinue v1. Since v1 receipts will then no longer be able to be created in Picqer, you can discontinue the v1 support from that moment as well. This page will be updated with more details at that time.

See this migration guide to learn more about the technical and conceptual changes.

Attributes

Get all receipts

Filters

You can filter the receipts with the following parameters. Add these filters as querystring parameters to the URL.

Get single receipt

The receipt response differs based on the version of the receipt.

Version 1

Version 2

The following example is for a v2 receipt. Note that the products returned in this response are received and added to the stock already. Expected products are not included in this response anymore, you can use the "Get expected products" endpoint to see those.

Get expected products

This endpoint returns the expected-products, including the strategies that you can use to receive this product. See "Add product" to find out more on using these strategies.

You can also request the applicable strategies for a specific product by providing an 'idproduct'.

Create a new receipt

You can create a receipt for a purchase order by providing 'idpurchaseorder', or for a supplier by providing 'idsupplier'.

Mark all products as received

After you created a receipt for a purchase order, you can mark all products as received. This will set the amount received to the amount you ordered.

Complete receipt

If you complete a receipt, we will set the status to "completed". For v1 receipts, products are added to the stock at this point.

As a response you do not see the status changed, this will be done in the background. If you retrieve the receipt again, you see status changed to 'completed' and the user and date of the completion filled.

Delete receipt

It depends on the version of the receipt until when a receipt can be deleted. Products should not have been added to the stock yet. In v1 this means that any "processing" receipt can be deleted. For v2, only receipts where not a single product is received can be deleted.

Add product

The workings and response for this endpoint differ between the two receipt versions.

Version 1

If you want to mark product for product as received, use this endpoint to increment the amount received by 1. You can provide a barcode or a idproduct.

You get the matched receipt product as a response.

If you want to add a product that is not on the receipt yet, then provide the idproduct and the parameter force as 'true'.

Version 2

You can receive a product by providing the associated purchase-order product. The amount and location will be used to directly add the product to the stock at the given location, this can also be a container.

The example above implicitly uses the "purchaseorder_product" strategy by default, you can otherwise choose to use 'automatic' or 'new'.

The 'automatic' strategy will divide the amount over purchase-orders which expect the product. The "new" strategy will add the product to a new purchase-order.

Note that the 'automatic' strategy can return multiple results, 1 per associated purchaseorder-product.

Revert product

You can revert a received product only when the stock is still available, this will decrease the stock by the received amount and will mark the receipt-product as reverted.

Change amount or location of product on receipt

Use this endpoint if you want to provide a specific amount that is received, or change the linked stock location.

Provide delta to change the amount up or down, or provide amount to set the amount to the given value.

Provide stock_idlocation to change the linked location to receive the stock on. You can only provide a location that is already linked to the product or 'null' to select "no specific location".

Comments

Comments are supported on receipts.