Registrar un bien recibido

El punto final POST /pic/link/goods-receipts/create le permite registrar la recepción de bienes asociados con una orden de compra. 👔💼🤝

Authorización

Este endpoint requiere autenticación a través de Basic Auth con el nombre de usuario y contraseña del backend que lo consumirá. Para crear y configurar un backend, siga el tutorial de backends

Parámetros requeridos

👣 Path

Esta solicitud no contiene parámetros de tipo Path

🔍 Query

Esta solicitud no contiene parámetros de tipo "Query"

💪 Body

Cuerpo del JSON

{
  "inputs": [
    GoodsReceipt
  ]
}

Nombre	Tipo	Por defecto	Descripción
inputs	Array[GoodsReceipt]	Required	Listado de los bienes recibidos a registrar

---

GoodsReceipt

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

Nombre	Tipo	Por defecto	Descripción
header	GoodsReceiptHeader	Required	Datos de cabecera de bienes recibidos.
items	Array[GoodsReceiptItem]	Required	Lista de artículos de bienes recibidos.

---

GoodsReceiptHeader

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

Nombre	Tipo	Por defecto	Descripción
goodsReceiptId	string	Required	Identificador del bien recibido
purchaseOrderId	string	Required	Identificador de la orden de compra
locationId	string	Required	Identificador de ubicación
storageId	string	Required	Identificador del almacenamiento
receiptDate	string	Required	Fecha de recibo
goodsReceiptFileKey	string	Required	Clave del archivo de bienes recibidos

caution

La fecha de recepción debe estar en formato DD-MM-AAAA para poder procesarse correctamente.

caution

El campo purchaseOrderId debe ser el identificador de una orden de compra creada desde el mismo backend a través del punto final POST /pic/link/purchase-orders/create.

info

El campo locationId debe corresponder al mapeo externo de una ubicación de AppliQloud.

info

El campo goodsReceiptFileKey se obtiene a través de la salida del punto final POST /pic/link/goods-receipts/files.

---

GoodsReceiptItem

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

Nombre	Tipo	Por defecto	Descripción
itemId	string	Required	Identificador de artículo de bienes recibidos
purchaseOrderItemId	string	Required	Identificador de artículo de orden de compra para bienes recibidos
quantity	int	Required	Cantidad recibida
unitId	string	Required	Unidad de medida de la cantidad recibida

caution

El artículo de la orden de compra debe tener un tipo de artículo de GOODS y un tipo de adscripción de INVENTORY para poder registrar una entrada de mercancías.

Ejemplos

🖥️ 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

Asegúrese de modificar los campos <identifier> y <token> con el identificador de su empresa y el token de autenticación respectivamente.

Respuestas

✅ 201

Los bienes recibidos se registraron correctamente.

{
   "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)

Hay un error en la solicitud.

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

🔒 401

Se requiere autorización o las credenciales no son correctas

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

🚧 500

Error interno del servidor (comuníquese con support@appliqloud.com o abra un ticket de soporte)

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