Goods Receipt

Get A Resource By ID

HTTP Request

GET /api/v1/goods-receipt/{id}

Interactive Demo

📋 Description: Returns the single resource with the given ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Resource ID

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "availableQuantity": 0,
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update A Resource

HTTP Request

PUT /api/v1/goods-receipt/{id}

Interactive Demo

📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Resource ID
body	body	GoodsReceiptDto	true	Request body containing the updated details of the goods receipt, including item quantities, supplier information, and relevant metadata for inventory management.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "state": "INV_DRAFT",
  "receivingDate": "2019-08-24",
  "notes": "string",
  "vendor": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "name": "string",
    "erpSystemDisplayId": "string"
  },
  "company": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "name": "string",
    "postingPeriodVariantId": 0,
    "fiscalVariantId": 0
  },
  "packingSlipId": "string",
  "goodsReceiptLineItems": [
    {
      "id": 0,
      "displayId": "string",
      "quantity": 0,
      "invoicedQuantity": 0,
      "description": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "expenseCategoryType": "PAYMENT"
      },
      "goodsReceiptId": 0,
      "goodsReceiptDisplayId": "string",
      "goodsReceiptState": "INV_DRAFT",
      "purchaseOrderLineItemId": 0,
      "invoiceLineItemLinks": [
        {
          "id": 0,
          "fromId": 0,
          "toId": 0,
          "linkedQuantity": 0
        }
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "purchaseOrderIds": [
    0
  ],
  "purchaseOrderDisplayIds": [
    "string"
  ],
  "invoiceIds": [
    0
  ],
  "invoiceDisplayIds": [
    "string"
  ],
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "availableQuantity": 0,
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete A Single Resource

HTTP Request

DELETE /api/v1/goods-receipt/{id}

Interactive Demo

📋 Description: Permanently deletes the resource with the given ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partially Update A Resource (Json Patch)

HTTP Request

PATCH /api/v1/goods-receipt/{id}

Interactive Demo

📋 Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	JsonPatch	true	Request body containing the updated goods receipt information, including item details, quantities, and any relevant adjustments for inventory management.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "availableQuantity": 0,
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/goods-receipt/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response errors list. The response body always contains the successfully processed items alongside any per-item errors.

Parameters

Name	In	Type	Required	Description
body	body	GoodsReceiptDto	true	Request body containing an array of goods receipt records for bulk creation or update, including essential details such as item identifiers, quantities, and associated metadata.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "state": "INV_DRAFT",
      "receivingDate": "2019-08-24",
      "notes": "string",
      "vendor": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemDisplayId": "string"
      },
      "company": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "packingSlipId": "string",
      "goodsReceiptLineItems": [
        {
          "id": 0,
          "displayId": "string",
          "quantity": 0,
          "invoicedQuantity": 0,
          "description": "string",
          "expenseCategory": {
            "id": 0,
            "displayId": "string",
            "status": "CREATED",
            "name": "string",
            "expenseCategoryType": "PAYMENT"
          },
          "goodsReceiptId": 0,
          "goodsReceiptDisplayId": "string",
          "goodsReceiptState": "INV_DRAFT",
          "purchaseOrderLineItemId": 0,
          "invoiceLineItemLinks": [
            {
              "id": 0,
              "fromId": 0,
              "toId": 0,
              "linkedQuantity": 0
            }
          ],
          "availableQuantity": 0,
          "allowsSystemGenerateNewId": true,
          "numberRangeIdentifierValue": "string",
          "numberRangeIdentifierType": {
            "name": "string"
          },
          "numberRangeType": {
            "name": "string"
          }
        }
      ],
      "purchaseOrderIds": [
        0
      ],
      "purchaseOrderDisplayIds": [
        "string"
      ],
      "invoiceIds": [
        0
      ],
      "invoiceDisplayIds": [
        "string"
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Or Update A Resource

HTTP Request

PUT /api/v1/goods-receipt/createOrUpdate

Interactive Demo

📋 Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.

Parameters

Name	In	Type	Required	Description
body	body	GoodsReceiptDto	true	Request body containing the goods receipt information, including item details, quantities, and associated metadata for creating or updating inventory records.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "state": "INV_DRAFT",
  "receivingDate": "2019-08-24",
  "notes": "string",
  "vendor": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "name": "string",
    "erpSystemDisplayId": "string"
  },
  "company": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "name": "string",
    "postingPeriodVariantId": 0,
    "fiscalVariantId": 0
  },
  "packingSlipId": "string",
  "goodsReceiptLineItems": [
    {
      "id": 0,
      "displayId": "string",
      "quantity": 0,
      "invoicedQuantity": 0,
      "description": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "expenseCategoryType": "PAYMENT"
      },
      "goodsReceiptId": 0,
      "goodsReceiptDisplayId": "string",
      "goodsReceiptState": "INV_DRAFT",
      "purchaseOrderLineItemId": 0,
      "invoiceLineItemLinks": [
        {
          "id": 0,
          "fromId": 0,
          "toId": 0,
          "linkedQuantity": 0
        }
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "purchaseOrderIds": [
    0
  ],
  "purchaseOrderDisplayIds": [
    "string"
  ],
  "invoiceIds": [
    0
  ],
  "invoiceDisplayIds": [
    "string"
  ],
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "availableQuantity": 0,
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk-Update Resources

HTTP Request

PUT /api/v1/goods-receipt/bulk

Interactive Demo

📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response errors list. The response body always contains the successfully updated items alongside any per-item errors.

Parameters

Name	In	Type	Required	Description
body	body	GoodsReceiptDto	true	Request body containing an array of goods receipt records, each including item details, quantities, and associated metadata for bulk processing.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "state": "INV_DRAFT",
      "receivingDate": "2019-08-24",
      "notes": "string",
      "vendor": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemDisplayId": "string"
      },
      "company": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "packingSlipId": "string",
      "goodsReceiptLineItems": [
        {
          "id": 0,
          "displayId": "string",
          "quantity": 0,
          "invoicedQuantity": 0,
          "description": "string",
          "expenseCategory": {
            "id": 0,
            "displayId": "string",
            "status": "CREATED",
            "name": "string",
            "expenseCategoryType": "PAYMENT"
          },
          "goodsReceiptId": 0,
          "goodsReceiptDisplayId": "string",
          "goodsReceiptState": "INV_DRAFT",
          "purchaseOrderLineItemId": 0,
          "invoiceLineItemLinks": [
            {
              "id": 0,
              "fromId": 0,
              "toId": 0,
              "linkedQuantity": 0
            }
          ],
          "availableQuantity": 0,
          "allowsSystemGenerateNewId": true,
          "numberRangeIdentifierValue": "string",
          "numberRangeIdentifierType": {
            "name": "string"
          },
          "numberRangeType": {
            "name": "string"
          }
        }
      ],
      "purchaseOrderIds": [
        0
      ],
      "purchaseOrderDisplayIds": [
        "string"
      ],
      "invoiceIds": [
        0
      ],
      "invoiceDisplayIds": [
        "string"
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk-Create Resources

HTTP Request

POST /api/v1/goods-receipt/bulk

Interactive Demo

📋 Description: Creates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response errors list. The response body always contains the successfully created items alongside any per-item errors.

Parameters

Name	In	Type	Required	Description
body	body	GoodsReceiptDto	true	Request body containing an array of goods receipt entries, each including essential details such as item identifiers, quantities, and associated supplier information for bulk processing.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "state": "INV_DRAFT",
      "receivingDate": "2019-08-24",
      "notes": "string",
      "vendor": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemDisplayId": "string"
      },
      "company": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "packingSlipId": "string",
      "goodsReceiptLineItems": [
        {
          "id": 0,
          "displayId": "string",
          "quantity": 0,
          "invoicedQuantity": 0,
          "description": "string",
          "expenseCategory": {
            "id": 0,
            "displayId": "string",
            "status": "CREATED",
            "name": "string",
            "expenseCategoryType": "PAYMENT"
          },
          "goodsReceiptId": 0,
          "goodsReceiptDisplayId": "string",
          "goodsReceiptState": "INV_DRAFT",
          "purchaseOrderLineItemId": 0,
          "invoiceLineItemLinks": [
            {
              "id": 0,
              "fromId": 0,
              "toId": 0,
              "linkedQuantity": 0
            }
          ],
          "availableQuantity": 0,
          "allowsSystemGenerateNewId": true,
          "numberRangeIdentifierValue": "string",
          "numberRangeIdentifierType": {
            "name": "string"
          },
          "numberRangeType": {
            "name": "string"
          }
        }
      ],
      "purchaseOrderIds": [
        0
      ],
      "purchaseOrderDisplayIds": [
        "string"
      ],
      "invoiceIds": [
        0
      ],
      "invoiceDisplayIds": [
        "string"
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk-Delete Resources

HTTP Request

DELETE /api/v1/goods-receipt/bulk

Interactive Demo

📋 Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A ValidationException containing per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of goods receipt identifiers to be deleted in bulk, facilitating efficient inventory management.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Unmark A Goods Receipt As Favourite

HTTP Request

POST /api/v1/goods-receipt/{goodsReceiptId}/remove-from-favorite

Interactive Demo

📋 Description: Unmark a goods receipt as favourite

Parameters

Name	In	Type	Required	Description
goodsReceiptId	path	integer(int64)	true	Unique identifier for the goods receipt

Responses

Status	Meaning	Description	Schema
200	OK	OK	FavouriteModel
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "internalId": "string",
  "foreignId": "string",
  "objectType": "string",
  "username": "string",
  "sequenceNumber": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Mark A Goods Receipt As Favourite

HTTP Request

POST /api/v1/goods-receipt/{goodsReceiptId}/add-to-favorite

Interactive Demo

📋 Description: Mark a goods receipt as favourite

Parameters

Name	In	Type	Required	Description
goodsReceiptId	path	integer(int64)	true	Unique identifier for the goods receipt

Responses

Status	Meaning	Description	Schema
200	OK	OK	FavouriteModel
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "internalId": "string",
  "foreignId": "string",
  "objectType": "string",
  "username": "string",
  "sequenceNumber": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search Resources

HTTP Request

POST /api/v1/goods-receipt/search

Interactive Demo

📋 Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	GoodsReceiptDtoFilter	false	Request body containing search criteria and filters for retrieving goods receipt records, enabling efficient tracking and management of inventory transactions.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["CREATED_AT,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "stateEqual": "INV_DRAFT",
  "stateIn": [
    "INV_DRAFT"
  ],
  "receivingDateEqual": "2019-08-24",
  "notesLike": "string",
  "vendorIdEqual": 0,
  "vendorIdIn": [
    0
  ],
  "vendorDisplayIdLike": "string",
  "companyIdEqual": 0,
  "companyIdIn": [
    0
  ],
  "packingSlipIdIn": [
    "string"
  ],
  "packingSlipIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "state": "INV_DRAFT",
      "receivingDate": "2019-08-24",
      "notes": "string",
      "vendor": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemDisplayId": "string"
      },
      "company": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "packingSlipId": "string",
      "goodsReceiptLineItems": [
        {
          "id": 0,
          "displayId": "string",
          "quantity": 0,
          "invoicedQuantity": 0,
          "description": "string",
          "expenseCategory": {
            "id": 0,
            "displayId": "string",
            "status": "CREATED",
            "name": "string",
            "expenseCategoryType": "PAYMENT"
          },
          "goodsReceiptId": 0,
          "goodsReceiptDisplayId": "string",
          "goodsReceiptState": "INV_DRAFT",
          "purchaseOrderLineItemId": 0,
          "invoiceLineItemLinks": [
            {
              "id": 0,
              "fromId": 0,
              "toId": 0,
              "linkedQuantity": 0
            }
          ],
          "availableQuantity": 0,
          "allowsSystemGenerateNewId": true,
          "numberRangeIdentifierValue": "string",
          "numberRangeIdentifierType": {
            "name": "string"
          },
          "numberRangeType": {
            "name": "string"
          }
        }
      ],
      "purchaseOrderIds": [
        0
      ],
      "purchaseOrderDisplayIds": [
        "string"
      ],
      "invoiceIds": [
        0
      ],
      "invoiceDisplayIds": [
        "string"
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search User Links On Goods Receipts

HTTP Request

POST /api/v1/goods-receipt/link/search

Interactive Demo

📋 Description: Search user links on goods receipts

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the search criteria and filters for linking goods receipts to relevant transactions.
» filter	body	UserLinkDtoFilter	false	Data transfer object representing the criteria for filtering user link records, enabling efficient retrieval and management of user associations within the system.
»» idIn	body	[integer]	false	Filter by multiple values of id
»» idEqual	body	integer(int64)	false	Filter by exact match of id
»» idLike	body	string	false	Filter by partial match of id
»» createdAtGreaterThanOrEqual	body	string(date-time)	false	Filter where created at is greater than or equal to specified value
»» createdAtLessThanOrEqual	body	string(date-time)	false	Filter where created at is less than or equal to specified value
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» modifiedAtGreaterThanOrEqual	body	string(date-time)	false	Filter where modified at is greater than or equal to specified value
»» modifiedAtLessThanOrEqual	body	string(date-time)	false	Filter where modified at is less than or equal to specified value
»» modifiedByLike	body	string	false	Filter by partial match of modified by
»» modifiedByEqual	body	string	false	Filter by exact match of modified by
»» displayIdIn	body	[string]	false	Filter by multiple values of display id
»» displayIdLike	body	string	false	Filter by partial match of display id
»» displayNameLike	body	string	false	Filter by partial match of display name
»» descriptionLike	body	string	false	Filter by partial match of description
»» urlLike	body	string	false	Filter by partial match of url
»» entityIdIn	body	[integer]	false	Filter by multiple values of entity id
»» entityIdEqual	body	integer(int64)	false	Filter by exact match of entity id
»» entityTypeIn	body	[string]	false	Filter by multiple values of entity type
»» entityTypeEqual	body	string	false	Filter by exact match of entity type
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Enumerated Values

Attribute	Value
»» entityTypeEqual	GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION
»» entityTypeIn	GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedByLike": "string",
    "modifiedByEqual": "string",
    "displayIdIn": [
      "string"
    ],
    "displayIdLike": "string",
    "displayNameLike": "string",
    "descriptionLike": "string",
    "urlLike": "string",
    "entityIdIn": [
      0
    ],
    "entityIdEqual": 0,
    "entityTypeIn": [
      "INVOICE"
    ],
    "entityTypeEqual": "INVOICE"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageUserLinkDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "displayName": "string",
      "description": "string",
      "url": "string",
      "entityId": 0,
      "entityType": "INVOICE",
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Or Update A User Link On A Goods Receipt

HTTP Request

POST /api/v1/goods-receipt/link/create-or-update

Interactive Demo

📋 Description: Attaches a user-defined hyperlink to a goods receipt. If a link with the same ID already exists it is updated; otherwise a new link is created.

Parameters

Name	In	Type	Required	Description
body	body	UserLinkDto	true	Request body containing the goods receipt details, including item specifications, quantities, and associated metadata for creating or updating records.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "displayName": "string",
  "description": "string",
  "url": "string",
  "entityId": 0,
  "entityType": "INVOICE",
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUserLinkDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "displayName": "string",
    "description": "string",
    "url": "string",
    "entityId": 0,
    "entityType": "INVOICE",
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Upload Documents To A Goods Receipt

HTTP Request

POST /api/v1/goods-receipt/document/upload

Interactive Demo

📋 Description: Attaches one or more files to the specified goods receipt.

Parameters

Name	In	Type	Required	Description
entityId	query	integer(int64)	true	Goods receipt ID
files	query	array[string]	false	Array of file objects to be uploaded as part of the goods receipt documentation process.

Responses

Status	Meaning	Description	Schema
200	OK	OK	MultipleUploadResult
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "uploadResults": [
    {
      "success": true,
      "originalFilename": "string",
      "resolvedFilename": "string",
      "failureReason": "string",
      "documentId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search Documents Attached To Goods Receipts

HTTP Request

POST /api/v1/goods-receipt/document/search

Interactive Demo

📋 Description: Search documents attached to goods receipts

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the search criteria and filters for retrieving goods receipt documents, ensuring efficient and targeted data retrieval.
» filter	body	DocumentReferenceDtoFilter	false	Data transfer object representing the criteria for filtering document references, enabling users to efficiently retrieve and manage relevant documents within the system.
»» idIn	body	[integer]	false	Filter by multiple values of id
»» idEqual	body	integer(int64)	false	Filter by exact match of id
»» idLike	body	string	false	Filter by partial match of id
»» createdAtGreaterThanOrEqual	body	string(date-time)	false	Filter where created at is greater than or equal to specified value
»» createdAtLessThanOrEqual	body	string(date-time)	false	Filter where created at is less than or equal to specified value
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» modifiedAtGreaterThanOrEqual	body	string(date-time)	false	Filter where modified at is greater than or equal to specified value
»» modifiedAtLessThanOrEqual	body	string(date-time)	false	Filter where modified at is less than or equal to specified value
»» modifiedByLike	body	string	false	Filter by partial match of modified by
»» modifiedByEqual	body	string	false	Filter by exact match of modified by
»» documentIdIn	body	[integer]	false	Filter by multiple values of document id
»» documentIdEqual	body	integer(int64)	false	Filter by exact match of document id
»» entityIdIn	body	[integer]	false	Filter by multiple values of entity id
»» entityIdEqual	body	integer(int64)	false	Filter by exact match of entity id
»» entityTypeIn	body	[string]	false	Filter by multiple values of entity type
»» entityTypeEqual	body	string	false	Filter by exact match of entity type
»» filenameLike	body	string	false	Filter by partial match of filename
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Enumerated Values

Attribute	Value
»» entityTypeEqual	GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION, WORKSPACE
»» entityTypeIn	GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION, WORKSPACE

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedByLike": "string",
    "modifiedByEqual": "string",
    "documentIdIn": [
      0
    ],
    "documentIdEqual": 0,
    "entityIdIn": [
      0
    ],
    "entityIdEqual": 0,
    "entityTypeIn": [
      "INVOICE"
    ],
    "entityTypeEqual": "INVOICE",
    "filenameLike": "string"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDocumentDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "filename": "string",
      "mimeType": "string",
      "fileSize": 0,
      "hash": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Advanced Goods Receipt Search

HTTP Request

POST /api/v1/goods-receipt/advanced-search

Interactive Demo

📋 Description: Full-text / multi-field search with faceting. Applies company-access and vendor-access filtering.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	GoodsReceiptSearchRequestDto	true	Request body containing advanced search criteria for goods receipt, including filters such as date range, supplier information, and item details to facilitate efficient inventory management.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["CREATED_AT,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "facets": [
    "ID"
  ],
  "facetSelections": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "aggregations": {
    "property1": {
      "type": "TERMS",
      "field": "ID",
      "size": 0,
      "missing": "string"
    },
    "property2": {
      "type": "TERMS",
      "field": "ID",
      "size": 0,
      "missing": "string"
    }
  },
  "filter": {
    "operator": "AND",
    "children": [
      {}
    ],
    "field": "ID",
    "comparison": "EQUAL",
    "value": "string",
    "values": [
      "string"
    ],
    "from": "string",
    "to": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	SearchResponseDtoGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "results": [
    {
      "id": 0,
      "displayId": "string",
      "state": "INV_DRAFT",
      "receivingDate": "2019-08-24",
      "notes": "string",
      "vendor": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemDisplayId": "string"
      },
      "company": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "packingSlipId": "string",
      "goodsReceiptLineItems": [
        {
          "id": 0,
          "displayId": "string",
          "quantity": 0,
          "invoicedQuantity": 0,
          "description": "string",
          "expenseCategory": {
            "id": 0,
            "displayId": "string",
            "status": "CREATED",
            "name": "string",
            "expenseCategoryType": "PAYMENT"
          },
          "goodsReceiptId": 0,
          "goodsReceiptDisplayId": "string",
          "goodsReceiptState": "INV_DRAFT",
          "purchaseOrderLineItemId": 0,
          "invoiceLineItemLinks": [
            {
              "id": 0,
              "fromId": 0,
              "toId": 0,
              "linkedQuantity": 0
            }
          ],
          "availableQuantity": 0,
          "allowsSystemGenerateNewId": true,
          "numberRangeIdentifierValue": "string",
          "numberRangeIdentifierType": {
            "name": "string"
          },
          "numberRangeType": {
            "name": "string"
          }
        }
      ],
      "purchaseOrderIds": [
        0
      ],
      "purchaseOrderDisplayIds": [
        "string"
      ],
      "invoiceIds": [
        0
      ],
      "invoiceDisplayIds": [
        "string"
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "facets": {
    "property1": {},
    "property2": {}
  },
  "aggregations": {
    "property1": {},
    "property2": {}
  },
  "pagination": {
    "number": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

List All Resources

HTTP Request

GET /api/v1/goods-receipt

Interactive Demo

📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the goods receipt retrieval should be paginated, enhancing the efficiency of data retrieval in large datasets.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "state": "INV_DRAFT",
      "receivingDate": "2019-08-24",
      "notes": "string",
      "vendor": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "erpSystemDisplayId": "string"
      },
      "company": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "packingSlipId": "string",
      "goodsReceiptLineItems": [
        {
          "id": 0,
          "displayId": "string",
          "quantity": 0,
          "invoicedQuantity": 0,
          "description": "string",
          "expenseCategory": {
            "id": 0,
            "displayId": "string",
            "status": "CREATED",
            "name": "string",
            "expenseCategoryType": "PAYMENT"
          },
          "goodsReceiptId": 0,
          "goodsReceiptDisplayId": "string",
          "goodsReceiptState": "INV_DRAFT",
          "purchaseOrderLineItemId": 0,
          "invoiceLineItemLinks": [
            {
              "id": 0,
              "fromId": 0,
              "toId": 0,
              "linkedQuantity": 0
            }
          ],
          "availableQuantity": 0,
          "allowsSystemGenerateNewId": true,
          "numberRangeIdentifierValue": "string",
          "numberRangeIdentifierType": {
            "name": "string"
          },
          "numberRangeType": {
            "name": "string"
          }
        }
      ],
      "purchaseOrderIds": [
        0
      ],
      "purchaseOrderDisplayIds": [
        "string"
      ],
      "invoiceIds": [
        0
      ],
      "invoiceDisplayIds": [
        "string"
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create A Resource

HTTP Request

POST /api/v1/goods-receipt

Interactive Demo

📋 Description: Creates a single resource. Returns the created resource with its generated ID.

Parameters

Name	In	Type	Required	Description
body	body	GoodsReceiptDto	true	Request body containing the details of the goods receipt, including item specifications, quantities, and associated supplier information for inventory management.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "state": "INV_DRAFT",
  "receivingDate": "2019-08-24",
  "notes": "string",
  "vendor": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "name": "string",
    "erpSystemDisplayId": "string"
  },
  "company": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "name": "string",
    "postingPeriodVariantId": 0,
    "fiscalVariantId": 0
  },
  "packingSlipId": "string",
  "goodsReceiptLineItems": [
    {
      "id": 0,
      "displayId": "string",
      "quantity": 0,
      "invoicedQuantity": 0,
      "description": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "expenseCategoryType": "PAYMENT"
      },
      "goodsReceiptId": 0,
      "goodsReceiptDisplayId": "string",
      "goodsReceiptState": "INV_DRAFT",
      "purchaseOrderLineItemId": 0,
      "invoiceLineItemLinks": [
        {
          "id": 0,
          "fromId": 0,
          "toId": 0,
          "linkedQuantity": 0
        }
      ],
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "purchaseOrderIds": [
    0
  ],
  "purchaseOrderDisplayIds": [
    "string"
  ],
  "invoiceIds": [
    0
  ],
  "invoiceDisplayIds": [
    "string"
  ],
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "state": "INV_DRAFT",
    "receivingDate": "2019-08-24",
    "notes": "string",
    "vendor": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "erpSystemDisplayId": "string"
    },
    "company": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    },
    "packingSlipId": "string",
    "goodsReceiptLineItems": [
      {
        "id": 0,
        "displayId": "string",
        "quantity": 0,
        "invoicedQuantity": 0,
        "description": "string",
        "expenseCategory": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "expenseCategoryType": "PAYMENT"
        },
        "goodsReceiptId": 0,
        "goodsReceiptDisplayId": "string",
        "goodsReceiptState": "INV_DRAFT",
        "purchaseOrderLineItemId": 0,
        "invoiceLineItemLinks": [
          {
            "id": 0,
            "fromId": 0,
            "toId": 0,
            "linkedQuantity": 0
          }
        ],
        "availableQuantity": 0,
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      }
    ],
    "purchaseOrderIds": [
      0
    ],
    "purchaseOrderDisplayIds": [
      "string"
    ],
    "invoiceIds": [
      0
    ],
    "invoiceDisplayIds": [
      "string"
    ],
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Workflow State History For A Goods Receipt

HTTP Request

GET /api/v1/goods-receipt/{goodsReceiptId}/state-history

Interactive Demo

📋 Description: Returns the ordered list of state transitions the goods receipt has gone through.

Parameters

Name	In	Type	Required	Description
goodsReceiptId	path	integer(int64)	true	Unique identifier for the goods receipt

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

[
  {
    "id": 0,
    "success": true,
    "failedMessage": "string",
    "warningMessage": "string",
    "fromState": "string",
    "event": "string",
    "comment": "string",
    "goodsReceiptRejectionReason": {
      "id": 0,
      "displayId": "string"
    },
    "goodsReceiptId": 0
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GoodsReceiptStateHistoryDto]	false	none	[Data transfer object representing the historical state changes of goods receipts, capturing essential metadata and timestamps for tracking the lifecycle of inventory transactions within the supply chain.]
» id	integer(int64)	false	none	Unique identifier for the resource
» success	boolean	false	none	Indicates whether the goods receipt process was successfully completed, reflecting the operational efficiency of inventory management.
» failedMessage	string	false	none	Contains a detailed message describing the reason for the failure in the goods receipt process, aiding in troubleshooting and resolution.
» warningMessage	string	false	none	Contains a descriptive message indicating any warnings related to the state history of the goods receipt process.
» fromState	string	false	none	Represents the previous state of the goods receipt, providing a historical context for tracking changes in the goods receipt process.
» event	string	false	none	Describes the specific event associated with the goods receipt state change, providing essential context for tracking inventory movements.
» comment	string	false	none	Textual feedback or remarks associated with the goods receipt state history, providing context for changes in status.
» goodsReceiptRejectionReason	BaseId	false	none	BaseId is a foundational data object that serves as a unique identifier for various entities within the system, ensuring consistent tracking and management across business processes.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
» goodsReceiptId	integer(int64)	false	none	Unique identifier for the goods receipt

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Check Whether A Goods Receipt Is Marked As Favourite By The Current User

HTTP Request

GET /api/v1/goods-receipt/{goodsReceiptId}/is-favorite

Interactive Demo

📋 Description: Check whether a goods receipt is marked as favourite by the current user

Parameters

Name	In	Type	Required	Description
goodsReceiptId	path	integer(int64)	true	Unique identifier for the goods receipt

Responses

Status	Meaning	Description	Schema
200	OK	OK	boolean
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

true

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Recently Viewed Goods Receipts For The Current User

HTTP Request

GET /api/v1/goods-receipt/recents

Interactive Demo

📋 Description: Get recently viewed goods receipts for the current user

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

[
  {
    "internalId": "string",
    "foreignId": "string",
    "objectType": "string",
    "recentType": "VIEWED",
    "username": "string",
    "lastAccess": "2019-08-24T14:15:22Z"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[RecentModel]	false	none	[Data transfer object representing the most recent model utilized in predictive analytics, encapsulating key attributes and performance metrics to support informed decision-making in business strategy.]
» internalId	string	false	none	Unique identifier for the internal
» foreignId	string	false	none	Unique identifier for the foreign
» objectType	string	false	none	Type of the object
» recentType	string	false	none	Type of the recent
» username	string	false	none	Represents the unique identifier for a user within the system, facilitating user management and authentication processes.
» lastAccess	string(date-time)	false	none	Timestamp indicating the most recent access to the resource, facilitating tracking of user engagement and system utilization.

Enumerated Values

Attribute	Value
recentType	APPROVED, CLOSED, MODIFIED, VIEWED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get All Goods Receipts Marked As Favourite By The Current User

HTTP Request

GET /api/v1/goods-receipt/favorites

Interactive Demo

📋 Description: Get all goods receipts marked as favourite by the current user

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

[
  {
    "internalId": "string",
    "foreignId": "string",
    "objectType": "string",
    "username": "string",
    "sequenceNumber": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[FavouriteModel]	false	none	[Data transfer object representing a user’s preferred items within the application, facilitating personalized experiences and enhancing user engagement.]
» internalId	string	false	none	Unique identifier for the internal
» foreignId	string	false	none	Unique identifier for the foreign
» objectType	string	false	none	Type of the object
» username	string	false	none	Represents the unique username associated with a user in the system, facilitating user identification and access management.
» sequenceNumber	integer(int32)	false	none	Sequential identifier for the favorite items, ensuring a consistent order within the user’s preferences.
» createdAt	string(date-time)	false	none	Timestamp when this resource was created

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete A User Link From A Goods Receipt

HTTP Request

DELETE /api/v1/goods-receipt/link/{linkId}

Interactive Demo

📋 Description: Delete a user link from a goods receipt

Parameters

Name	In	Type	Required	Description
linkId	path	integer(int64)	true	Link ID

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---