Purchasing Organization

Purchasing Organization - Get

HTTP Request

GET /api/v1/purchasing-organizations/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific purchasing organization within the financial organization structure, identified by the provided ID, to facilitate understanding of its role and hierarchy within the broader 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	ResponsePurchasingOrganizationDto

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",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
}

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

Purchasing Organization - Update

HTTP Request

PUT /api/v1/purchasing-organizations/{id}

Interactive Demo

📋 Description: Updates the details of a specified purchasing organization within the financial organization structure, allowing for modifications to the hierarchy and attributes of the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PurchasingOrganizationDto	true	Request body containing the updated details of the purchasing organization, including its hierarchical structure and associated financial entity attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "purchaseOrderId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchasingOrganizationDto

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",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
}

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

Purchasing Organization - Delete

HTTP Request

DELETE /api/v1/purchasing-organizations/{id}

Interactive Demo

📋 Description: Deletes a specified purchasing organization 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

Purchasing Organization - Delete Or Decommission

HTTP Request

PUT /api/v1/purchasing-organizations/remove/{id}

Interactive Demo

📋 Description: Removes a specified purchasing organization 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

Purchasing Organization - Delete Or Decommission All

HTTP Request

PUT /api/v1/purchasing-organizations/remove/bulk

Interactive Demo

📋 Description: Removes multiple purchasing organizations from the financial organization structure, facilitating updates to the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of purchasing organization identifiers to be removed in bulk from the financial entity’s organizational structure.

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

Purchasing Organization - Decommission

HTTP Request

PUT /api/v1/purchasing-organizations/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified purchasing organization within the financial entity structure, effectively removing it from the organizational hierarchy. This operation ensures that the financial organization maintains an accurate and up-to-date structure.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchasingOrganizationDto

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",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
}

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

Purchasing Organization - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/purchasing-organizations/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions purchasing organizations that have been modified before the specified date, ensuring the integrity and accuracy of the financial organization structure within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning purchasing organizations that were modified before the given date, ensuring alignment with organizational structure and hierarchy changes within the financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 0
    }
  ]
}

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

Purchasing Organization - Decommission Before Now

HTTP Request

PUT /api/v1/purchasing-organizations/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions purchasing organizations that have been modified before the current timestamp, ensuring the financial organization structure remains accurate and up-to-date. This operation helps maintain the integrity of the hierarchy within the financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 0
    }
  ]
}

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

Purchasing Organization - Decommission All

HTTP Request

PUT /api/v1/purchasing-organizations/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple purchasing organizations in a single operation, allowing for efficient management of financial entity structures and hierarchies within the organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of purchasing organization identifiers and their associated decommissioning details to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 0
    }
  ]
}

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

Purchasing Organization - Create Or Update Bulk

HTTP Request

PUT /api/v1/purchasing-organizations/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple purchasing organizations within the financial entity structure, ensuring accurate hierarchy and organization management.

Parameters

Name	In	Type	Required	Description
body	body	PurchasingOrganizationDto	true	Request body containing bulk data for creating or updating purchasing organizations, including hierarchical structure and financial entity details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 0
    }
  ]
}

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

Purchasing Organization - Create Or Update

HTTP Request

PUT /api/v1/purchasing-organizations/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a purchasing organization within the financial organization structure, ensuring accurate representation of the entity’s hierarchy and organizational framework.

Parameters

Name	In	Type	Required	Description
body	body	PurchasingOrganizationDto	true	Request body containing the details of the purchasing organization, including its hierarchical structure and associated financial entity information for creation or update purposes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "purchaseOrderId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchasingOrganizationDto

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",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
}

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

Purchasing Organization - Bulk Update

HTTP Request

PUT /api/v1/purchasing-organizations/bulk

Interactive Demo

📋 Description: Updates multiple purchasing organizations within the financial organization structure, allowing for efficient management of organizational hierarchies and relationships.

Parameters

Name	In	Type	Required	Description
body	body	PurchasingOrganizationDto	true	Request body containing a collection of purchasing organization data, including hierarchical relationships and attributes necessary for updating the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 0
    }
  ]
}

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

Purchasing Organization - Bulk Create

HTTP Request

POST /api/v1/purchasing-organizations/bulk

Interactive Demo

📋 Description: Creates multiple purchasing organizations within the financial organization structure, enabling efficient management of organizational hierarchies and enhancing operational capabilities.

Parameters

Name	In	Type	Required	Description
body	body	PurchasingOrganizationDto	true	Request body containing a bulk list of purchasing organization data, including hierarchical relationships and structural attributes relevant to financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 0
    }
  ]
}

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

Purchasing Organization - Bulk Delete

HTTP Request

DELETE /api/v1/purchasing-organizations/bulk

Interactive Demo

📋 Description: Deletes multiple purchasing organizations within the financial organization structure, allowing for streamlined management of organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of purchasing organization identifiers to facilitate the bulk deletion of financial entities within the organizational structure.

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

Purchasing Organization - Search

HTTP Request

POST /api/v1/purchasing-organizations/search

Interactive Demo

📋 Description: Submits a search request for purchasing organizations within the financial entity hierarchy, enabling users to efficiently locate and manage organizational structures.

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	PurchasingOrganizationDtoFilter	false	Request body containing search criteria and filters for identifying specific purchasing organizations within the financial entity’s organizational 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",
  "companyIdEqual": 0,
  "companyDisplayIdLike": "string",
  "purchaseOrderIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 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

Purchasing Organization - Detach Company

HTTP Request

POST /api/v1/purchasing-organizations/detach/company/{companyId}

Interactive Demo

📋 Description: Detaches a specified company from its associated purchasing organization within the financial organization structure, thereby updating the hierarchy of financial entities. This operation ensures accurate representation of organizational relationships in the system.

Parameters

Name	In	Type	Required	Description
companyId	path	integer(int64)	true	Unique identifier for the company
body	body	PurchasingOrganizationDto	true	Request body containing the details required to detach a specified company from its associated purchasing organization within the financial entity hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 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

Purchasing Organization - Attach Company

HTTP Request

POST /api/v1/purchasing-organizations/attach/company/{companyId}

Interactive Demo

📋 Description: Attaches a specified company to a purchasing organization within the financial organization structure, facilitating the establishment of hierarchical relationships between financial entities.

Parameters

Name	In	Type	Required	Description
companyId	path	integer(int64)	true	Unique identifier for the company
body	body	PurchasingOrganizationDto	true	Request body containing the financial entity details necessary to attach a purchasing organization to the specified company, including organizational structure and hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 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

Purchasing Organization - Find All

HTTP Request

GET /api/v1/purchasing-organizations

Interactive Demo

📋 Description: Retrieves a list of purchasing organizations within the financial organization structure, providing insights into the hierarchical relationships and entities involved in procurement activities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the purchasing organizations query should be returned in a paginated format, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 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

Purchasing Organization - Create

HTTP Request

POST /api/v1/purchasing-organizations

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	PurchasingOrganizationDto	true	Request body containing the details of the purchasing organization, including its hierarchical structure and associated financial entity information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "purchaseOrderId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePurchasingOrganizationDto

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",
    "companyId": 0,
    "companyDisplayId": "string",
    "purchaseOrderId": 0
  }
}

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

Purchasing Organization - Get Metadata

HTTP Request

GET /api/v1/purchasing-organizations/meta

Interactive Demo

📋 Description: Retrieves metadata for purchasing organizations 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

Purchasing Organization - Find All By System ID

HTTP Request

GET /api/v1/purchasing-organizations/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the details of a specific purchasing organization within the financial entity hierarchy based on the provided ERP system ID.

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 purchasing organization data within the financial entity hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 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

Purchasing Organization - Get All By Company

HTTP Request

GET /api/v1/purchasing-organizations/company/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific purchasing organization within the financial entity hierarchy, identified by the provided company 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, facilitating efficient retrieval of purchasing organization data within the financial entity’s hierarchical structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePurchasingOrganizationDto

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",
      "companyId": 0,
      "companyDisplayId": "string",
      "purchaseOrderId": 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

---