Find counterparty

get

https://{tenant}.bko.finologee.com/v2/counterparties

Find counterparty accounts using the search criteria. This is a paged endpoint that by default returns only the first 10 results, in ascending order of their internal ID.

Query Params

accountNumbers

array of strings

Account number for filtering counterparty accounts. Multiple account numbers are supported.

accountNumbers

bics

array of strings

Account BIC for filtering counterparty accounts. Multiple BICs are supported.

bics

accountNames

array of strings

Account name for filtering counterparty accounts. Multiple account names are supported.

accountNames

statuses

array of strings

Account status for filtering counterparty accounts. Multiple statuses are supported, and providing all possible statuses is equivalent to not using this filter at all.

statuses

externalIds

array of strings

External ID for filtering counterparty accounts. Multiple IDs are supported.

externalIds

counterpartyGroupIds

array of int64s

ID of counterparty group for filtering counterparties. Multiple IDs are supported.

counterpartyGroupIds

unpaged

string

Defaults to false

No pagination setup. If true, pageIndex and pageSize have no effect.

pageIndex

string

Defaults to 0

Zero-based page index (0..N)

pageSize

string

Defaults to 10

The size of the page to be returned

sort

array

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Provided JSON is valid, an array of matching counterparties is returned

400Bad Request: query params are invalid

401Unauthorized - Authorization Information Is Missing Or Invalid

403Forbidden - The User Has No Permissions For This Operation