Purchase Order

Purchase Order - Get

HTTP Request

GET /api/v1/purchase-orders/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific purchase order identified by its unique ID within the financial organization structure, facilitating insights into the organization’s procurement activities and hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
}

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

Purchase Order - Update

HTTP Request

PUT /api/v1/purchase-orders/{id}

Interactive Demo

📋 Description: Updates the details of a specific purchase order within the financial organization structure, allowing for modifications to align with the organization’s hierarchy and operational needs.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PurchaseOrderDto	true	Request body containing the updated purchase order details, including financial entity identifiers, organizational structure elements, and hierarchical adjustments.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "documentType": "string",
  "deletionIndicator": "string",
  "statusOfPurchasingDocument": "string",
  "vendor": "string",
  "purchasingGroup": "string",
  "yourReference": "string",
  "agreement": "string",
  "ourReference": "string",
  "releaseGroup": "string",
  "releaseIndicator": "string",
  "purchasingOrganizationId": 0,
  "purchasingOrganizationDisplayId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
}

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

Purchase Order - Delete

HTTP Request

DELETE /api/v1/purchase-orders/{id}

Interactive Demo

📋 Description: Deletes a specified purchase order from the financial organization structure, ensuring that the hierarchy and integrity of the financial entity are maintained.

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

Example Responses

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

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

Purchase Order - Delete Or Decommission

HTTP Request

PUT /api/v1/purchase-orders/remove/{id}

Interactive Demo

📋 Description: Removes a specified purchase order from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

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

Example Responses

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

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

Purchase Order - Delete Or Decommission All

HTTP Request

PUT /api/v1/purchase-orders/remove/bulk

Interactive Demo

📋 Description: Removes multiple purchase orders in bulk from the financial organization structure, ensuring efficient management of financial entities within the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of purchase order identifiers to be removed in bulk from the financial organization’s structure, ensuring efficient management of hierarchical financial entities.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Purchase Order - Decommission

HTTP Request

PUT /api/v1/purchase-orders/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified purchase order within the financial organization structure, effectively removing it from the active hierarchy of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
}

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

Purchase Order - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/purchase-orders/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Updates the status of purchase orders that were modified before the specified date, allowing financial organizations to efficiently manage their order hierarchy and structure.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning purchase orders that were modified before the given date, ensuring the financial organization maintains an accurate and up-to-date structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Purchase Order - Decommission Before Now

HTTP Request

PUT /api/v1/purchase-orders/decommission/modified-before-now

Interactive Demo

📋 Description: Updates the status of purchase orders that were modified before the current date, facilitating the management of financial entities within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Purchase Order - Decommission All

HTTP Request

PUT /api/v1/purchase-orders/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple purchase orders to ‘decommission’ within the financial organization structure, enabling efficient management of obsolete financial entities in the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a bulk decommissioning list of purchase orders, including identifiers and relevant financial entity details to facilitate organizational structure adjustments.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Purchase Order - Create Or Update Bulk

HTTP Request

PUT /api/v1/purchase-orders/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple purchase orders in bulk within the financial organization structure, ensuring alignment with the hierarchical framework of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PurchaseOrderDto	true	Request body containing a bulk array of purchase order data, including details necessary for creating or updating financial entities within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Purchase Order - Create Or Update

HTTP Request

PUT /api/v1/purchase-orders/createOrUpdate

Interactive Demo

📋 Description: Creates or updates purchase orders within the financial organization structure, ensuring alignment with the established hierarchy and organizational requirements.

Parameters

Name	In	Type	Required	Description
body	body	PurchaseOrderDto	true	Request body containing the purchase order details, including financial entity identifiers and hierarchical structure information for effective organization management.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "documentType": "string",
  "deletionIndicator": "string",
  "statusOfPurchasingDocument": "string",
  "vendor": "string",
  "purchasingGroup": "string",
  "yourReference": "string",
  "agreement": "string",
  "ourReference": "string",
  "releaseGroup": "string",
  "releaseIndicator": "string",
  "purchasingOrganizationId": 0,
  "purchasingOrganizationDisplayId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
}

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

Purchase Order - Bulk Update

HTTP Request

PUT /api/v1/purchase-orders/bulk

Interactive Demo

📋 Description: Updates multiple purchase orders in bulk within the financial organization structure, allowing for efficient management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	PurchaseOrderDto	true	Request body containing an array of purchase order details, including financial entity identifiers and hierarchical organization data, for bulk processing within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Purchase Order - Bulk Create

HTTP Request

POST /api/v1/purchase-orders/bulk

Interactive Demo

📋 Description: Submits multiple purchase orders in a single request, facilitating efficient processing within the financial organization structure and enhancing the management of hierarchical purchasing activities.

Parameters

Name	In	Type	Required	Description
body	body	PurchaseOrderDto	true	Request body containing an array of purchase order details, including financial entity identifiers and hierarchical organization structure information, for bulk processing within the financial organization framework.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Purchase Order - Bulk Delete

HTTP Request

DELETE /api/v1/purchase-orders/bulk

Interactive Demo

📋 Description: Deletes multiple purchase orders in a single operation, streamlining the management of financial entities within the organizational structure.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of purchase order IDs to be deleted in bulk, reflecting the organization’s financial structure and hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Purchase Order - Search

HTTP Request

POST /api/v1/purchase-orders/search

Interactive Demo

📋 Description: Submits a search request for purchase orders within the financial organization structure, allowing users to filter results based on organizational hierarchy and specific financial entities.

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	PurchaseOrderDtoFilter	false	Request body containing search criteria for purchase orders, including parameters related to the organization’s financial structure and hierarchy.

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",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "nameLike": "string",
  "documentTypeLike": "string",
  "deletionIndicatorLike": "string",
  "statusOfPurchasingDocumentLike": "string",
  "vendorLike": "string",
  "purchasingGroupLike": "string",
  "yourReferenceLike": "string",
  "agreementLike": "string",
  "ourReferenceLike": "string",
  "releaseGroupLike": "string",
  "releaseIndicatorLike": "string",
  "purchasingOrganizationIdEqual": 0,
  "purchasingOrganizationDisplayIdLike": "string",
  "companyIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchaseOrderDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ],
  "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

Purchase Order - Detach Purchase Organization

HTTP Request

POST /api/v1/purchase-orders/detach/purchase-organization/{relation_id}

Interactive Demo

📋 Description: Detaches a specified purchase organization from the financial entity hierarchy, allowing for adjustments in the organizational structure. This operation ensures accurate representation of financial relationships within the organization.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the financial entity’s relationship within the organizational structure, used to detach a purchase organization from a purchase order.
body	body	PurchaseOrderDto	true	Request body containing the details required to detach a purchase organization from the financial entity hierarchy, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Purchase Order - Attach Purchase Organization

HTTP Request

POST /api/v1/purchase-orders/attach/purchase-organization/{relation_id}

Interactive Demo

📋 Description: Attaches a specified purchase organization to a purchase order, facilitating the alignment of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the financial organization structure, representing the relationship between the purchase order and the associated financial entity.
body	body	PurchaseOrderDto	true	Request body containing the purchase organization details, including hierarchical relationships and associated financial entity information for the specified relation ID.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Purchase Order - Find All

HTTP Request

GET /api/v1/purchase-orders

Interactive Demo

📋 Description: Retrieves a list of purchase orders associated with the financial organization structure, allowing users to view and manage orders within the specified organizational hierarchy.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing for efficient retrieval of purchase orders within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchaseOrderDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ],
  "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

Purchase Order - Create

HTTP Request

POST /api/v1/purchase-orders

Interactive Demo

📋 Description: Creates a new purchase order within the financial organization structure, enabling the establishment of hierarchical relationships and management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PurchaseOrderDto	true	Request body containing the purchase order details, including financial entity identifiers, item specifications, and hierarchical organization structure information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "documentType": "string",
  "deletionIndicator": "string",
  "statusOfPurchasingDocument": "string",
  "vendor": "string",
  "purchasingGroup": "string",
  "yourReference": "string",
  "agreement": "string",
  "ourReference": "string",
  "releaseGroup": "string",
  "releaseIndicator": "string",
  "purchasingOrganizationId": 0,
  "purchasingOrganizationDisplayId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchaseOrderDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "documentType": "string",
    "deletionIndicator": "string",
    "statusOfPurchasingDocument": "string",
    "vendor": "string",
    "purchasingGroup": "string",
    "yourReference": "string",
    "agreement": "string",
    "ourReference": "string",
    "releaseGroup": "string",
    "releaseIndicator": "string",
    "purchasingOrganizationId": 0,
    "purchasingOrganizationDisplayId": "string",
    "companyId": 0
  }
}

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

Purchase Order - Get All By Purchase Organization

HTTP Request

GET /api/v1/purchase-orders/purchase-organization/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific purchase organization within the financial entity hierarchy, identified by the provided ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing for efficient retrieval of purchase orders within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchaseOrderDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ],
  "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

Purchase Order - Get Metadata

HTTP Request

GET /api/v1/purchase-orders/meta

Interactive Demo

📋 Description: Retrieves metadata related to purchase orders within the financial organization structure, providing insights into the hierarchy and relationships of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

Purchase Order - Find All By System ID

HTTP Request

GET /api/v1/purchase-orders/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves purchase order details from the specified ERP system, allowing users to access essential information related to the organization’s financial structure and hierarchy.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of purchase orders within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchaseOrderDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "documentType": "string",
      "deletionIndicator": "string",
      "statusOfPurchasingDocument": "string",
      "vendor": "string",
      "purchasingGroup": "string",
      "yourReference": "string",
      "agreement": "string",
      "ourReference": "string",
      "releaseGroup": "string",
      "releaseIndicator": "string",
      "purchasingOrganizationId": 0,
      "purchasingOrganizationDisplayId": "string",
      "companyId": 0
    }
  ],
  "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

---