Partner Contact

Partner Contact - Get

HTTP Request

GET /api/v1/partner-contacts/{id}

Interactive Demo

📋 Description: Fetches detailed information about a specific partner contact within the financial organization structure, identified by the provided ID, to facilitate effective relationship management and organizational hierarchy understanding.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
}

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

Partner Contact - Update

HTTP Request

PUT /api/v1/partner-contacts/{id}

Interactive Demo

📋 Description: Updates the details of a specific partner contact within the financial organization structure, allowing for adjustments to the hierarchy and relationships of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PartnerContactDto	true	Request body containing updated contact information and organizational role details for a specified partner within the financial entity’s structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "position": "string",
  "address": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "partnerId": 0,
  "contactRoleId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
}

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

Partner Contact - Delete

HTTP Request

DELETE /api/v1/partner-contacts/{id}

Interactive Demo

📋 Description: Deletes a specified partner contact 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

Partner Contact - Delete Or Decommission

HTTP Request

PUT /api/v1/partner-contacts/remove/{id}

Interactive Demo

📋 Description: Removes a specified partner contact from the financial organization 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 Contact - Delete Or Decommission All

HTTP Request

PUT /api/v1/partner-contacts/remove/bulk

Interactive Demo

📋 Description: Removes multiple partner contacts from the financial organization structure in a single operation, ensuring an updated hierarchy for effective management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of partner contact identifiers to be removed in bulk from the financial organization’s structure, ensuring efficient management of 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

Partner Contact - Decommission

HTTP Request

PUT /api/v1/partner-contacts/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified partner contact 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	ResponsePartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
}

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

Partner Contact - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/partner-contacts/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions partner contacts within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains current and relevant. This operation helps maintain an accurate representation of financial entities by removing outdated contacts.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning partner contacts, allowing for the targeted management of financial entity relationships within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 0
    }
  ]
}

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

Partner Contact - Decommission Before Now

HTTP Request

PUT /api/v1/partner-contacts/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions partner contacts that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with operational requirements.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 0
    }
  ]
}

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

Partner Contact - Decommission All

HTTP Request

PUT /api/v1/partner-contacts/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple partner contacts within the financial organization structure, facilitating the 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 partner contact identifiers and decommissioning details for bulk processing within the financial organization’s hierarchical structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 0
    }
  ]
}

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

Partner Contact - Create Or Update Bulk

HTTP Request

PUT /api/v1/partner-contacts/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple partner contact records in bulk, ensuring alignment with the financial organization structure and hierarchy of the entity. This operation facilitates efficient management of partner relationships within the organization.

Parameters

Name	In	Type	Required	Description
body	body	PartnerContactDto	true	Request body containing a bulk array of partner contact records, including details necessary for creating or updating financial entity relationships within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 0
    }
  ]
}

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

Partner Contact - Create Or Update

HTTP Request

PUT /api/v1/partner-contacts/createOrUpdate

Interactive Demo

📋 Description: Updates or creates partner contact information within the financial organization structure, ensuring accurate representation of relationships and hierarchy for effective management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PartnerContactDto	true	Request body containing the details of partner contacts, including identification, role, and organizational hierarchy, to facilitate the creation or updating of financial entity relationships.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "position": "string",
  "address": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "partnerId": 0,
  "contactRoleId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
}

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

Partner Contact - Bulk Update

HTTP Request

PUT /api/v1/partner-contacts/bulk

Interactive Demo

📋 Description: Updates multiple partner contact records in a single request, enabling efficient management of financial organization structures and hierarchies.

Parameters

Name	In	Type	Required	Description
body	body	PartnerContactDto	true	Request body containing a bulk list of partner contact information, including organizational hierarchy details and associated financial entity attributes.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 0
    }
  ]
}

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

Partner Contact - Bulk Create

HTTP Request

POST /api/v1/partner-contacts/bulk

Interactive Demo

📋 Description: Submits a bulk upload of partner contact information to enhance the financial organization structure, ensuring accurate representation of relationships within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PartnerContactDto	true	Request body containing a collection of partner contact details, including organizational hierarchy and financial entity information, for bulk processing within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 0
    }
  ]
}

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

Partner Contact - Bulk Delete

HTTP Request

DELETE /api/v1/partner-contacts/bulk

Interactive Demo

📋 Description: Deletes multiple partner contact records in a single operation, streamlining the management of your financial organization’s structure and hierarchy.

Parameters

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

Partner Contact - Search

HTTP Request

POST /api/v1/partner-contacts/search

Interactive Demo

📋 Description: Submits a search request for partner contacts within the financial organization structure, allowing users to identify and retrieve relevant contact information based on specified criteria.

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	PartnerContactDtoFilter	false	Request body containing search criteria and filters for retrieving partner contact information within the financial organization structure.

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",
  "nameLike": "string",
  "emailLike": "string",
  "phoneLike": "string",
  "positionLike": "string",
  "addressLike": "string",
  "groupLike": "string",
  "buildingNameLike": "string",
  "faxLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemDisplayIdLike": "string",
  "partnerIdEqual": 0,
  "contactRoleIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerContactDto

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",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 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 Contact - Detach Partner

HTTP Request

POST /api/v1/partner-contacts/detach/partner/{partner_id}

Interactive Demo

📋 Description: Detaches a specified partner contact from the financial organization structure, facilitating updates to the hierarchy and ensuring accurate representation of relationships within the financial entity.

Parameters

Name	In	Type	Required	Description
partner_id	path	integer(int64)	true	Unique identifier for the financial entity partner within the organizational structure, used to detach associated contacts.
body	body	PartnerContactDto	true	Request body containing the details of the partner contact to be detached from the specified financial entity, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 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 Contact - Attach Partner

HTTP Request

POST /api/v1/partner-contacts/attach/partner/{partner_id}

Interactive Demo

📋 Description: Attaches a specified partner contact to the designated partner within the financial organization structure, facilitating enhanced communication and collaboration across the entity’s hierarchy.

Parameters

Name	In	Type	Required	Description
partner_id	path	integer(int64)	true	Unique identifier for the partner within the financial organization structure, used to associate contacts with the specified partner in the hierarchy.
body	body	PartnerContactDto	true	Request body containing the partner contact details, including identification and relationship information, essential for establishing and managing the financial organization structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 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 Contact - Find All

HTTP Request

GET /api/v1/partner-contacts

Interactive Demo

📋 Description: Retrieves a list of partner contacts within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports efficient navigation and management of organizational contacts.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the partner contacts retrieval should be paginated, facilitating efficient navigation through the organizational hierarchy of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerContactDto

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",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 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 Contact - Create

HTTP Request

POST /api/v1/partner-contacts

Interactive Demo

📋 Description: Creates a new partner contact within the financial organization structure, enabling the establishment of relationships and hierarchies essential for managing financial entities effectively.

Parameters

Name	In	Type	Required	Description
body	body	PartnerContactDto	true	Request body containing the details of partner contacts, including organizational affiliation and hierarchical structure within the financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "position": "string",
  "address": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "partnerId": 0,
  "contactRoleId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerContactDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "position": "string",
    "address": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "partnerId": 0,
    "contactRoleId": 0
  }
}

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

Partner Contact - Get All By Partner

HTTP Request

GET /api/v1/partner-contacts/partner/{id}

Interactive Demo

📋 Description: Fetches detailed information about a specific partner contact within the financial organization structure, identified by the provided partner ID, to support organizational hierarchy and entity management.

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 the retrieval of partner contact records within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerContactDto

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",
      "name": "string",
      "email": "string",
      "phone": "string",
      "position": "string",
      "address": "string",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "partnerId": 0,
      "contactRoleId": 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 Contact - Get Metadata

HTTP Request

GET /api/v1/partner-contacts/meta

Interactive Demo

📋 Description: Retrieves metadata related to partner contacts within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports effective management and understanding of organizational dynamics.

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

---