Partner

Partner - Get

HTTP Request

GET /api/v1/partners/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial entity within the organizational structure by its unique identifier, facilitating insights into the hierarchy and relationships of partners.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerDto

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",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
}

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

Partner - Update

HTTP Request

PUT /api/v1/partners/{id}

Interactive Demo

📋 Description: Updates the details of a specified financial partner within the organization’s 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	PartnerDto	true	Request body containing the updated financial entity details, including organizational structure and hierarchy information for the specified partner.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "fax": "string",
  "phone": "string",
  "parentId": 0,
  "parentName": "string",
  "parentDisplayId": "string",
  "companyId": 0,
  "partnerRoleId": 0,
  "partnerContactId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerDto

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",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
}

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

Partner - Delete

HTTP Request

DELETE /api/v1/partners/{id}

Interactive Demo

📋 Description: Deletes a specified financial entity partner from the organization’s structure, ensuring the hierarchy remains accurate and up-to-date.

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

Partner - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified partner from the financial organization structure, ensuring the integrity of the hierarchy and maintaining accurate records 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

Partner - Delete Or Decommission All

HTTP Request

PUT /api/v1/partners/remove/bulk

Interactive Demo

📋 Description: Removes multiple 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 financial entity identifiers for bulk removal from the organizational structure 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

Partner - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified financial entity within the organizational structure, effectively removing it from the hierarchy. This operation ensures that the financial organization remains accurate and up-to-date by eliminating inactive or obsolete partners.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerDto

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",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
}

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

Partner - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions financial entities in the organizational structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with business objectives. This operation helps maintain an accurate representation of the financial organization by removing outdated entities.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning partners, ensuring that only those modified before this date are processed within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ]
}

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

Partner - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions financial entities within the organization structure that have been modified before the current date, ensuring the hierarchy remains up-to-date and aligned with business requirements.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ]
}

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

Partner - Decommission All

HTTP Request

PUT /api/v1/partners/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple partners within the financial organization structure, enabling the effective management of organizational hierarchy and ensuring accurate representation of active financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entities to be decommissioned in bulk, including their organizational hierarchy and structural identifiers.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ]
}

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

Partner - Create Or Update Bulk

HTTP Request

PUT /api/v1/partners/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple partner records within the financial organization structure, enabling efficient management of organizational hierarchy and relationships with financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PartnerDto	true	Request body containing bulk data for creating or updating financial entities within the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ]
}

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

Partner - Create Or Update

HTTP Request

PUT /api/v1/partners/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a financial entity within the organizational structure, allowing for the seamless integration and management of partner relationships in the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	PartnerDto	true	Request body containing the financial entity details necessary for creating or updating the organization structure and hierarchy of partners.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "fax": "string",
  "phone": "string",
  "parentId": 0,
  "parentName": "string",
  "parentDisplayId": "string",
  "companyId": 0,
  "partnerRoleId": 0,
  "partnerContactId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerDto

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",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
}

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

Partner - Bulk Update

HTTP Request

PUT /api/v1/partners/bulk

Interactive Demo

📋 Description: Updates the financial organization structure by allowing the bulk modification of partner entities, ensuring alignment with the hierarchical framework of the financial entity.

Parameters

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

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ]
}

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

Partner - Bulk Create

HTTP Request

POST /api/v1/partners/bulk

Interactive Demo

📋 Description: Submits a bulk upload of partner entities to establish or update the financial organization structure, ensuring accurate representation of the hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	PartnerDto	true	Request body containing a bulk upload of financial entity data, including organizational structure and hierarchy details for partner integration.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ]
}

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

Partner - Bulk Delete

HTTP Request

DELETE /api/v1/partners/bulk

Interactive Demo

📋 Description: Deletes multiple partner entries from the financial organization structure, allowing for streamlined management of organizational hierarchies and relationships within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for bulk deletion within the organizational structure 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

Partner - Search

HTTP Request

POST /api/v1/partners/search

Interactive Demo

📋 Description: Submits a request to search for financial entities within the organizational structure, allowing users to identify and analyze hierarchical relationships among partners.

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	PartnerDtoFilter	false	Request body containing search criteria and filters for identifying financial entities within the 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",
  "notIdIn": [
    0
  ],
  "uiSelector": "string",
  "nameLike": "string",
  "faxLike": "string",
  "phoneLike": "string",
  "parentIdEqual": 0,
  "parentNameEqual": "string",
  "parentDisplayIdLike": "string",
  "companyIdEqual": 0,
  "companyIdIn": [
    0
  ],
  "partnerRoleIdEqual": 0,
  "partnerContactIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 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

Partner - Detach Company

HTTP Request

POST /api/v1/partners/detach/company/{company_id}

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to detach a partner from the specified company.
body	body	PartnerDto	true	Request body containing the details necessary to detach a financial entity from the organizational structure, including the company ID and relevant metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 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

Partner - Attach Company

HTTP Request

POST /api/v1/partners/attach/company/{company_id}

Interactive Demo

📋 Description: Attaches a specified company to the financial organization structure, facilitating the integration of the company’s hierarchy within the broader organizational framework.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organization’s structure, used to attach a partner to the specified company.
body	body	PartnerDto	true	Request body containing the financial entity details required to attach a partner to the specified company within the organizational hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 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

Partner - Find All

HTTP Request

GET /api/v1/partners

Interactive Demo

📋 Description: Retrieves a list of financial entities within the organizational structure, providing insights into the hierarchy and relationships among partners.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of partner data within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 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

Partner - Create

HTTP Request

POST /api/v1/partners

Interactive Demo

📋 Description: Creates a new partner entry within the financial organization structure, enabling the establishment of hierarchical relationships and enhancing the overall organizational framework.

Parameters

Name	In	Type	Required	Description
body	body	PartnerDto	true	Request body containing the organizational structure data for a financial entity, including hierarchy details and partner information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "fax": "string",
  "phone": "string",
  "parentId": 0,
  "parentName": "string",
  "parentDisplayId": "string",
  "companyId": 0,
  "partnerRoleId": 0,
  "partnerContactId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerDto

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",
    "fax": "string",
    "phone": "string",
    "parentId": 0,
    "parentName": "string",
    "parentDisplayId": "string",
    "companyId": 0,
    "partnerRoleId": 0,
    "partnerContactId": 0
  }
}

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

Partner - Get Metadata

HTTP Request

GET /api/v1/partners/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, including details on partners and their hierarchical relationships within the financial entity.

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

Partner - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the details of a specified ERP system within the financial organization structure, providing insights into the organization’s hierarchy and financial entity 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 the retrieval of financial organization structure data for the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 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

Partner - Get All By Company

HTTP Request

GET /api/v1/partners/company/{company_id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial entity within the organizational structure by its unique company identifier, facilitating insights into the hierarchy and relationships of partners.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organization structure, used to retrieve partner information associated with the specified company.
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating the retrieval of hierarchical data related to financial entities within the organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerDto

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",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 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

---