Get paged FX contracts

post

https://apim.demo01.my.fivedegrees.cloud/sbx/account-fxcontract/search

API endpoint to search for FX contracts.

SortColumn is required: one of ExternalPortfolioId, CreatedDate, CreatedBy, ChangedDate,
ChangedBy, ExternalReference, UTI, ContractNumber, ContractDate, ContractType, ContractState
(see GetPagedFXContractsRequestDto.SortColumn). SortOrder is optional: "Ascending" or
"Descending" (case-insensitive, defaults to "Ascending"). An unrecognized or missing
SortColumn results in a 400 response.

Body Params

The get paged FX contracts request dto

The Get Paged FX Contracts Dto

sortColumn

string | null

The column the results should be sorted by. One of: ExternalPortfolioId, CreatedDate,
CreatedBy, ChangedDate, ChangedBy, ExternalReference, UTI, ContractNumber, ContractDate,
ContractType, ContractState. An unrecognized value is rejected by the server. Currently
required: omitting it also results in a rejection (the server's own fallback does not pass
its own validation) â€” always pass an explicit value from the list above.

sortOrder

string | null

Sort order of the results: Ascending or Descending. Case-insensitive; defaults to Ascending
if omitted or not recognized.

pageNumber

int32 | null

The requested page number (start with 1)

pageSize

int32 | null

The requested page size to fetch

filter

object

Criteria for filtering FX contracts

Headers

accept-version

string

required

Defaults to v1

API versioning

x-request-id

uuid

required

Correlates HTTP requests between a client and server

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK

400Bad Request

401Unauthorized

403Forbidden