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.

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

Receiving products

The steps to receive products via the API are:

• Create a new receipt (POST /api/v1/receipts)
• Get expected products (GET /api/v1/receipts/{idreceipt}/expected-products)
• Add products (POST /api/v1/receipts/{idreceipt}/products)
• Complete receipt (PUT /api/v1/receipts/{idreceipt})

Create a new receipt

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

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

Add product

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.

You can use different strategies for selecting the purchase order when adding a product to a receipt.

There are 3 strategies:

1. purchaseorder_product (default) - This strategy will register the amount on a specific purchaseorder product. Provide the idpurchaseorder_product in the request.
2. automatic - This strategy will automatically divide the amount over open purchaseorder products. This strategy is only relevant for receipts not based on a specific purchase order.
3. new - This strategy will add the product to either the linked purchase order or a freshly created purchase order for excessive products.

Since the automatic strategy can result in multiple entries for different purchase order products the response has a collection of receipt-products instead of a single receipt-product.

To use a strategy other than 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.

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.

Comments

Comments are supported on receipts.

Below are some endpoints that only work for older v1 receipts:

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.

Add product with v1

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

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