Register a goods receipt

The POST /pic/link/goods-receipts/create endpoint allows you to register the receipt of goods associated with a purchase order. 👔💼🤝

Authorization

This endpoint requires authentication through Basic Auth with the username and password of the backend that will consume it. To create and configure a backend, follow the backends tutorial

Request parameters

👣 Path

This request does not contain parameters of type Path

🔍 Query

This request does not contain parameters of type Query

💪 Body

JSON Body

{
  "inputs": [
    GoodsReceipt
  ]
}

Name	Type	Default	Description
inputs	Array[GoodsReceipt]	Required	List of goods receipts to register

---

GoodsReceipt

{
  "header": GoodsReceiptHeader,
  "items": [
    GoodsReceiptItem
  ]
}

Name	Type	Default	Description
header	GoodsReceiptHeader	Required	Header data of goods received
items	Array[GoodsReceiptItem]	Required	List of items of goods received

---

GoodsReceiptHeader

{
  "goodsReceipt_id": string,
  "purchaseOrder_id": string,
  "locationId": string,
  "storageId": string | null,
  "receiptDate": string,
  "goodsReceiptFileKey": string | null,
}

Name	Type	Default	Description
goodsReceiptId	string	Required	Identifier of the goods receipt
purchaseOrderId	string	Required	Identifier of the purchase order
locationId	string	Required	Identifier of location
storageId	string | null	null	Identifier of the storage
receiptDate	string	Required	Receipt date
goodsReceiptFileKey	string	Required	File key of goods receipt

caution

The receipt date must be in DD-MM-YYYY format in order to be processed correctly.

caution

The purchaseOrderId field must be the identifier of a purchase order created from the same backend through the POST /pic/link/purchase-orders/create endpoint.

info

The locationId field must correspond to the external mapping of an AppliQloud location.

info

The goodsReceiptFileKey field is obtained through the output of the POST /pic/link/goods-receipts/files endpoint.

---

GoodsReceiptItem

{
  "itemId": string,
  "purchaseOrderItemId": string,
  "quantity": int,
  "unitId": string,
}

Name	Type	Default	Description
itemId	string	Required	Goods received item identifier
purchaseOrderItemId	string	Required	PO item identifier for goods received
quantity	int	Required	Received amount
unitId	string	Required	Unit of measurement of the quantity received

caution

The purchase order item must have an item type of GOODS and an ascription type of INVENTORY to be able to register a goods receipt.

Examples

🖥️ cURL

curl --location 'https://<identifier>.api.appliqloud.com/pic/link/goods-receipts/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
    "inputs": [
        {
          "header": {
            "goodsReceiptId": "43000001",
            "purchaseOrderId": "450000001",
            "locationId": "MX-LOC",
            "storageId": "ST1",
            "receiptDate": "2024-08-09",
            "goodsReceiptFileKey": "goods-receipts/d6963433-6d75-4ea6-a7b5-0596546e767f.jpg"
          },
          "items": [
            {
              "itemId": "0",
              "purchaseOrderItemId": "10",
              "quantity": 3,
              "unitId": "EA"
            }
          ]
        }
    ]
}'

caution

Make sure to modify the <identifier> and <token> fields with your company identifier and authentication token respectively.

Responses

✅ 201

The goods receipts were successfully registered

{
   "success":[
      {
         "header":{
            "goodsReceiptId":"43000001",
            "goodsReceiptStatus":"CLOSED",
            "vendorBusinessPartnerId":"1245",
            "purchaseOrderId":"450000001",
            "locationId":"MX-LOC",
            "storageId":"ST1",
            "receiptDate":"2024-08-09",
            "goodsReceiptFile":{
               "key":"goods-receipts/d6963433-6d75-4ea6-a7b5-0596546e767f.jpg",
               "url":"https://s3.us-west-2.amazonaws.com/dev-apq-demos-bucket/goods-receipts/d6963433-6d75-4ea6-a7b5-0596546e767f.jpg"
            }
         },
         "items":[
            {
               "itemId":"0",
               "purchaseOrderItemId":"10",
               "quantity":3,
               "unitId":"EA",
               "netUnitPrice":6000.0,
               "netTotalPrice":18000.0
            }
         ]
      }
   ],
   "errors":[
      
   ]
}

⚠️ 201 (with errors)

There is an error in the request

{
    "success": [],
    "errors": [
      {
        "traceId": "3095a0a77f80436ba104eb2fc24ba343"
        "cause": "GoodsReceiptAlreadyExistsException",
        "message": "Goods receipt 43000002 already exists in backend SAP_APQ",
        "context": {
          "backendId": "SAP_APQ",
          "goodsReceiptId": "43000002"
        }
      }
    ]
}

🔒 401

Authorization required or credentials are not correct

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343",
    "cause": "UnauthorizedException",
    "message": "Authorization required"
}

🚧 500

Internal server error (contact support@appliqloud.com or open a support ticket)

{
    "success": [],
    "errors": [     
      {
          "traceId": "3095a0a77f80436ba104eb2fc24ba343"
          "cause": "InternalServerError",
          "message": "Internal Server Error"
      }
    ]
}