Trading Partner

Trading Partner - Get

HTTP Request

GET /api/v1/trading-partners/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific trading partner within the financial organization structure, identified by the unique partner ID, to facilitate understanding of the organization’s hierarchy and relationships.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTradingPartnerDto

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",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
}

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

Trading Partner - Update

HTTP Request

PUT /api/v1/trading-partners/{id}

Interactive Demo

📋 Description: Updates the details of a specified trading partner 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	TradingPartnerDto	true	Request body containing the updated details of the trading partner, including organizational structure and hierarchy information relevant to the financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "countryDisplayId": "string",
  "currencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTradingPartnerDto

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",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
}

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

Trading Partner - Delete

HTTP Request

DELETE /api/v1/trading-partners/{id}

Interactive Demo

📋 Description: Deletes a specified trading partner from the financial organization structure, ensuring the integrity of the hierarchy and facilitating effective management 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	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

Trading Partner - Delete Or Decommission

HTTP Request

PUT /api/v1/trading-partners/remove/{id}

Interactive Demo

📋 Description: Removes a specified trading partner from the financial organization structure, ensuring the integrity of the hierarchy within the entity’s operational framework.

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

Trading Partner - Delete Or Decommission All

HTTP Request

PUT /api/v1/trading-partners/remove/bulk

Interactive Demo

📋 Description: Removes multiple trading partners from the financial organization structure in a single operation, ensuring efficient management of the entity’s hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of trading partner identifiers to be removed in bulk from the financial organization structure, ensuring accurate hierarchy management.

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

Trading Partner - Decommission

HTTP Request

PUT /api/v1/trading-partners/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified trading partner within the financial organization structure, effectively removing it from the active hierarchy and ensuring compliance with organizational changes.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTradingPartnerDto

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",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
}

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

Trading Partner - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/trading-partners/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions trading partners that have been modified before the specified date, ensuring the integrity of the financial organization structure by removing outdated entities from the hierarchy.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning trading partners that were modified before the given date, ensuring alignment with the organization’s financial structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "string"
    }
  ]
}

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

Trading Partner - Decommission Before Now

HTTP Request

PUT /api/v1/trading-partners/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions trading partners that have been modified before the current date, ensuring the financial organization structure remains current and aligned with operational requirements.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "string"
    }
  ]
}

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

Trading Partner - Decommission All

HTTP Request

PUT /api/v1/trading-partners/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple trading partners within the financial organization structure, allowing for efficient management of organizational hierarchy and entity relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of trading partner identifiers and their decommissioning details, structured to facilitate bulk updates within the financial organization hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "string"
    }
  ]
}

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

Trading Partner - Create Or Update Bulk

HTTP Request

PUT /api/v1/trading-partners/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple trading partners in the financial organization structure, ensuring accurate representation of the entity hierarchy and relationships within the system.

Parameters

Name	In	Type	Required	Description
body	body	TradingPartnerDto	true	Request body containing bulk data for creating or updating trading partner information, including organizational hierarchy and financial entity details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "string"
    }
  ]
}

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

Trading Partner - Create Or Update

HTTP Request

PUT /api/v1/trading-partners/createOrUpdate

Interactive Demo

📋 Description: Updates or creates a trading partner within the financial organization structure, ensuring that the hierarchy and relationships of financial entities are accurately maintained. This operation facilitates the management of organizational relationships essential for effective financial operations.

Parameters

Name	In	Type	Required	Description
body	body	TradingPartnerDto	true	Request body containing the details of the trading partner, including organizational structure, hierarchy, and relevant financial entity information for creation or update purposes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "countryDisplayId": "string",
  "currencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTradingPartnerDto

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",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
}

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

Trading Partner - Bulk Update

HTTP Request

PUT /api/v1/trading-partners/bulk

Interactive Demo

📋 Description: Updates the financial organization structure by allowing bulk modifications of trading partner details, ensuring alignment with the hierarchy and operational needs of the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	TradingPartnerDto	true	Request body containing a bulk update of trading partner information, including organizational structure and hierarchy details for financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "string"
    }
  ]
}

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

Trading Partner - Bulk Create

HTTP Request

POST /api/v1/trading-partners/bulk

Interactive Demo

📋 Description: Creates multiple trading partner entries in the financial organization structure, allowing for efficient management of organizational hierarchies and relationships within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TradingPartnerDto	true	Request body containing a list of trading partner entities, including their hierarchical relationships and organizational attributes, to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "string"
    }
  ]
}

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

Trading Partner - Bulk Delete

HTTP Request

DELETE /api/v1/trading-partners/bulk

Interactive Demo

📋 Description: Deletes multiple trading partners from the financial organization structure, allowing for streamlined management of hierarchical relationships within the entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of trading partner identifiers to be deleted from the financial organization structure, reflecting changes in the organizational 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

Trading Partner - Search

HTTP Request

POST /api/v1/trading-partners/search

Interactive Demo

📋 Description: Submits a search request for trading partners within the financial organization structure, allowing users to identify and analyze relationships and hierarchies among 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	TradingPartnerDtoFilter	false	Request body containing criteria for searching trading partners within the financial organization structure, including relevant attributes such as organization hierarchy and entity details.

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",
  "uiSelector": "string",
  "nameLike": "string",
  "countryDisplayIdLike": "string",
  "currencyDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "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

Trading Partner - Find All

HTTP Request

GET /api/v1/trading-partners

Interactive Demo

📋 Description: Retrieves a list of trading partners within the financial organization structure, providing insights into the hierarchy and relationships among financial entities. This operation supports efficient management and analysis of organizational partnerships.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "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

Trading Partner - Create

HTTP Request

POST /api/v1/trading-partners

Interactive Demo

📋 Description: Creates a new trading partner 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	TradingPartnerDto	true	Request body containing the details of the trading partner, including organizational structure and hierarchy information relevant to the financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "countryDisplayId": "string",
  "currencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTradingPartnerDto

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",
    "countryDisplayId": "string",
    "currencyDisplayId": "string"
  }
}

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

Trading Partner - Get Metadata

HTTP Request

GET /api/v1/trading-partners/meta

Interactive Demo

📋 Description: Retrieves metadata related to trading partners 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

Trading Partner - Find All By System ID

HTTP Request

GET /api/v1/trading-partners/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves detailed information about a specific ERP system associated with trading partners within the financial organization structure, facilitating insights into organizational hierarchy and relationships.

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 trading partner data within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTradingPartnerDto

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",
      "countryDisplayId": "string",
      "currencyDisplayId": "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

---