Goods Receipt Line Item

Get A Resource By ID

HTTP Request

GET /api/v1/goods-receipt-line-item/{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	ResponseGoodsReceiptLineItemDto
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",
    "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"
    }
  }
}

🔐 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-line-item/{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	GoodsReceiptLineItemDto	true	Request body containing the updated details of the goods receipt line item, including quantity, item description, and associated metadata for inventory management.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptLineItemDto
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",
    "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"
    }
  }
}

🔐 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-line-item/{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-line-item/{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 updated details for the specified goods receipt line item, including quantity, status, and any relevant adjustments.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptLineItemDto
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",
    "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"
    }
  }
}

🔐 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-line-item/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	GoodsReceiptLineItemDto	true	Request body containing a collection of goods receipt line items for bulk creation or update, including relevant details such as item identifiers, quantities, and associated metadata.

Body Parameters

[
  {
    "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"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGoodsReceiptLineItemDto
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",
      "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"
      }
    }
  ]
}

🔐 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-line-item/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	GoodsReceiptLineItemDto	true	Request body containing the details of the goods receipt line item, including item specifications, quantities, and associated metadata for creation or updating purposes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptLineItemDto
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",
    "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"
    }
  }
}

🔐 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-line-item/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	GoodsReceiptLineItemDto	true	Request body containing a collection of goods receipt line items for bulk processing, including relevant details such as item identifiers, quantities, and associated metadata.

Body Parameters

[
  {
    "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"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGoodsReceiptLineItemDto
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",
      "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"
      }
    }
  ]
}

🔐 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-line-item/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	GoodsReceiptLineItemDto	true	Request body containing a collection of goods receipt line item details, including quantities, item identifiers, and associated metadata for bulk processing.

Body Parameters

[
  {
    "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"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGoodsReceiptLineItemDto
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",
      "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"
      }
    }
  ]
}

🔐 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-line-item/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 identifiers for the goods receipt line items to be deleted in bulk.

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

Unlink Goods Receipt Line Items From Purchase Order Line Items

HTTP Request

POST /api/v1/goods-receipt-line-item/unlink-goods-receipt-to-purchase-order-line-items

Interactive Demo

📋 Description: Removes the association between the specified goods receipt line items and their purchase order line items. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.

Parameters

Name	In	Type	Required	Description
body	body	LinkPOLineItemToGoodsReceiptLineItemDto	true	Request body containing the identifiers for the goods receipt and associated purchase order line items to facilitate the unlinking process.

Body Parameters

[
  {
    "purchaseOrderLineItemId": 0,
    "goodsReceiptLineItemId": 0
  }
]

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,
    "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"
    }
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GoodsReceiptLineItemDto]	false	none	[Data transfer object representing a line item within a goods receipt, detailing the specific items received, their quantities, and associated metadata to facilitate inventory management and financial reconciliation.]
» id	integer(int64)	false	none	Unique identifier for the resource
» displayId	string	false	none	Unique identifier for the display
» quantity	integer(int64)	false	none	Quantity value
» invoicedQuantity	integer(int64)	false	none	Quantity of invoiced quantity
» description	string	false	none	Description of the resource
» expenseCategory	ExpenseCategoryLite	false	none	Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
»» expenseCategoryType	string	false	none	Type of the expense category
» goodsReceiptId	integer(int64)	true	none	Unique identifier for the goods receipt
» goodsReceiptDisplayId	string	false	none	Unique identifier for the goods receipt display
» goodsReceiptState	string	false	none	Indicates the current status of the goods receipt, reflecting its processing stage within the supply chain management system.
» purchaseOrderLineItemId	integer(int64)	false	none	Unique identifier for the purchase order line item
» invoiceLineItemLinks	[InvoiceLineItemToGoodsReceiptLineItemDto]	false	none	Array of links to associated invoice line items, facilitating the tracking and management of goods receipt transactions.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» fromId	integer(int64)	false	none	Unique identifier for the from
»» toId	integer(int64)	false	none	Unique identifier for the to
»» linkedQuantity	integer(int64)	false	none	Quantity of linked quantity
» availableQuantity	integer(int64)	false	read-only	Quantity of available quantity
» allowsSystemGenerateNewId	boolean	false	none	Unique identifier for the allows system generate new
» numberRangeIdentifierValue	string	false	none	Represents a unique identifier for the range of numbers associated with a specific goods receipt line item, facilitating accurate tracking and management of inventory.
» numberRangeIdentifierType	INumberRangeIdentifierType	false	none	Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management.
»» name	string	false	none	Name of the resource
» numberRangeType	INumberRangeType	false	none	Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency.
»» name	string	true	none	Name of the resource

Enumerated Values

Attribute	Value
expenseCategoryType	CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION
goodsReceiptState	GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

🔐 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-line-item/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	GoodsReceiptLineItemDtoFilter	false	Request body containing search criteria and filters for retrieving specific goods receipt line items relevant to inventory management.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,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",
  "quantityEqual": 0,
  "invoicedQuantityEqual": 0,
  "descriptionLike": "string",
  "expenseCategoryIdEqual": 0,
  "expenseCategoryDisplayIdLike": "string",
  "goodsReceiptIdIn": [
    0
  ],
  "goodsReceiptIdEqual": 0,
  "goodsReceiptDisplayIdIn": [
    "string"
  ],
  "goodsReceiptDisplayIdEqual": "string",
  "goodsReceiptStateIn": [
    "INV_DRAFT"
  ],
  "goodsReceiptStateEqual": "INV_DRAFT",
  "purchaseOrderLineItemIdIn": [
    0
  ],
  "purchaseOrderLineItemIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGoodsReceiptLineItemDto
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",
      "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"
      }
    }
  ],
  "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

Record Goods Receipt Line Items From Purchase Order Line Items

HTTP Request

POST /api/v1/goods-receipt-line-item/record-goods-receipt-from-purchase-order-line-items

Interactive Demo

📋 Description: Creates new goods receipt line items pre-populated from the specified purchase order line items. Each DTO specifies the goods receipt, PO line item, and received quantity. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.

Parameters

Name	In	Type	Required	Description
body	body	RecordGoodsReceiptFromPOLineItemDto	true	Request body containing the details of goods receipt line items, including associated purchase order line item identifiers and quantities, necessary for accurate inventory and financial reconciliation.

Body Parameters

[
  {
    "purchaseOrderLineItemId": 0,
    "goodsReceiptId": 0,
    "quantity": 0
  }
]

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,
    "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"
    }
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GoodsReceiptLineItemDto]	false	none	[Data transfer object representing a line item within a goods receipt, detailing the specific items received, their quantities, and associated metadata to facilitate inventory management and financial reconciliation.]
» id	integer(int64)	false	none	Unique identifier for the resource
» displayId	string	false	none	Unique identifier for the display
» quantity	integer(int64)	false	none	Quantity value
» invoicedQuantity	integer(int64)	false	none	Quantity of invoiced quantity
» description	string	false	none	Description of the resource
» expenseCategory	ExpenseCategoryLite	false	none	Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
»» expenseCategoryType	string	false	none	Type of the expense category
» goodsReceiptId	integer(int64)	true	none	Unique identifier for the goods receipt
» goodsReceiptDisplayId	string	false	none	Unique identifier for the goods receipt display
» goodsReceiptState	string	false	none	Indicates the current status of the goods receipt, reflecting its processing stage within the supply chain management system.
» purchaseOrderLineItemId	integer(int64)	false	none	Unique identifier for the purchase order line item
» invoiceLineItemLinks	[InvoiceLineItemToGoodsReceiptLineItemDto]	false	none	Array of links to associated invoice line items, facilitating the tracking and management of goods receipt transactions.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» fromId	integer(int64)	false	none	Unique identifier for the from
»» toId	integer(int64)	false	none	Unique identifier for the to
»» linkedQuantity	integer(int64)	false	none	Quantity of linked quantity
» availableQuantity	integer(int64)	false	read-only	Quantity of available quantity
» allowsSystemGenerateNewId	boolean	false	none	Unique identifier for the allows system generate new
» numberRangeIdentifierValue	string	false	none	Represents a unique identifier for the range of numbers associated with a specific goods receipt line item, facilitating accurate tracking and management of inventory.
» numberRangeIdentifierType	INumberRangeIdentifierType	false	none	Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management.
»» name	string	false	none	Name of the resource
» numberRangeType	INumberRangeType	false	none	Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency.
»» name	string	true	none	Name of the resource

Enumerated Values

Attribute	Value
expenseCategoryType	CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION
goodsReceiptState	GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

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

Link Goods Receipt Line Items To Purchase Order Line Items

HTTP Request

POST /api/v1/goods-receipt-line-item/link-goods-receipt-to-purchase-order-line-items

Interactive Demo

📋 Description: Associates existing goods receipt line items with purchase order line items. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.

Parameters

Name	In	Type	Required	Description
body	body	LinkPOLineItemToGoodsReceiptLineItemDto	true	Request body containing the details necessary to link goods receipt line items to their corresponding purchase order line items, ensuring accurate inventory and financial tracking.

Body Parameters

[
  {
    "purchaseOrderLineItemId": 0,
    "goodsReceiptLineItemId": 0
  }
]

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,
    "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"
    }
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GoodsReceiptLineItemDto]	false	none	[Data transfer object representing a line item within a goods receipt, detailing the specific items received, their quantities, and associated metadata to facilitate inventory management and financial reconciliation.]
» id	integer(int64)	false	none	Unique identifier for the resource
» displayId	string	false	none	Unique identifier for the display
» quantity	integer(int64)	false	none	Quantity value
» invoicedQuantity	integer(int64)	false	none	Quantity of invoiced quantity
» description	string	false	none	Description of the resource
» expenseCategory	ExpenseCategoryLite	false	none	Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
»» expenseCategoryType	string	false	none	Type of the expense category
» goodsReceiptId	integer(int64)	true	none	Unique identifier for the goods receipt
» goodsReceiptDisplayId	string	false	none	Unique identifier for the goods receipt display
» goodsReceiptState	string	false	none	Indicates the current status of the goods receipt, reflecting its processing stage within the supply chain management system.
» purchaseOrderLineItemId	integer(int64)	false	none	Unique identifier for the purchase order line item
» invoiceLineItemLinks	[InvoiceLineItemToGoodsReceiptLineItemDto]	false	none	Array of links to associated invoice line items, facilitating the tracking and management of goods receipt transactions.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» fromId	integer(int64)	false	none	Unique identifier for the from
»» toId	integer(int64)	false	none	Unique identifier for the to
»» linkedQuantity	integer(int64)	false	none	Quantity of linked quantity
» availableQuantity	integer(int64)	false	read-only	Quantity of available quantity
» allowsSystemGenerateNewId	boolean	false	none	Unique identifier for the allows system generate new
» numberRangeIdentifierValue	string	false	none	Represents a unique identifier for the range of numbers associated with a specific goods receipt line item, facilitating accurate tracking and management of inventory.
» numberRangeIdentifierType	INumberRangeIdentifierType	false	none	Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management.
»» name	string	false	none	Name of the resource
» numberRangeType	INumberRangeType	false	none	Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency.
»» name	string	true	none	Name of the resource

Enumerated Values

Attribute	Value
expenseCategoryType	CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION
goodsReceiptState	GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

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

Advanced Goods Receipt Line Item Search

HTTP Request

POST /api/v1/goods-receipt-line-item/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	GoodsReceiptLineItemSearchRequestDto	true	Request body containing the criteria for advanced searching of goods receipt line items, including filters such as item details, quantities, and associated metadata.

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	SearchResponseDtoGoodsReceiptLineItemDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "results": [
    {
      "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"
      }
    }
  ],
  "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-line-item

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 line items should be returned in a paginated format, facilitating efficient data retrieval and management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGoodsReceiptLineItemDto
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",
      "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"
      }
    }
  ],
  "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-line-item

Interactive Demo

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

Parameters

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

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGoodsReceiptLineItemDto
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",
    "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"
    }
  }
}

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

---