@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiTradingAccountsModelDefinition

Interface: AffiliateApiTradingAccountsModelDefinition

@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiTradingAccountsModelDefinition

The model definition for a trading account in the Affiliate API.

Since

v1.20240429.0

Hierarchy

ModuleModelDefinition
↳ AffiliateApiTradingAccountsModelDefinition

Properties

balance

• balance: Object

Whether the trading account's balance

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:150

commission

• commission: Object

Whether the trading account's commission

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:270

createdTime

• createdTime: Object

The date and time when the trading account was created

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`string`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: string

Defined in

src/clients/affiliateApi/tradingAccounts.ts:285

credit

• credit: Object

Whether the trading account's credit

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:180

currency

• currency: Object

The trading account's currency

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`string`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: string

Defined in

src/clients/affiliateApi/tradingAccounts.ts:105

customerId

• customerId: Object

The unique identifier of the trading account's customer in the database

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`string`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: string

Defined in

src/clients/affiliateApi/tradingAccounts.ts:31

email

• email: Object

The email of the trading account's customer in the database

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`string`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: string

Defined in

src/clients/affiliateApi/tradingAccounts.ts:46

enabled

• enabled: Object

Whether the trading account is enabled

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/tradingAccounts.ts:120

equity

• equity: Object

Whether the trading account's equity

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:165

id

• id: Object

The unique identifier of the trading account in the database

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`string`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: string

Defined in

src/clients/affiliateApi/tradingAccounts.ts:16

leverage

• leverage: Object

Whether the trading account's leverage

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:210

• login: Object

The trading account's login

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`string`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: string

Defined in

src/clients/affiliateApi/tradingAccounts.ts:61

margin

• margin: Object

Whether the trading account's margin

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:225

pnl

• pnl: Object

Whether the trading account's pnl

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:195

readOnly

• readOnly: Object

Whether the trading account is in read-only mode

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/tradingAccounts.ts:135

server

• server: Object

The trading account's account server

Type declaration

Name	Type
`filters`	{ `contain`: `true` ; `match`: `true` }
`filters.contain`	`true`
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`"real"` \| `"demo"`

filters: { contain: true ; match: true }

filters.contain: true

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: "real" | "demo"

Defined in

src/clients/affiliateApi/tradingAccounts.ts:76

swaps

• swaps: Object

Whether the trading account's swaps

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:240

taxes

• taxes: Object

Whether the trading account's taxes

Type declaration

Name	Type
`filters`	{ `match`: `true` ; `range`: `true` }
`filters.match`	`true`
`filters.range`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`number`

filters: { match: true ; range: true }

filters.match: true

filters.range: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: number

Defined in

src/clients/affiliateApi/tradingAccounts.ts:255

tradingPlatform

• tradingPlatform: Object

The trading account's trading platform

Type declaration

Name	Type
`filters`	{ `match`: `true` }
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`"MT4"` \| `"MT5"`

filters: { match: true }

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: "MT4" | "MT5"

Defined in

src/clients/affiliateApi/tradingAccounts.ts:91

Interface: AffiliateApiTradingAccountsModelDefinition ​

Hierarchy ​

Properties ​

balance ​

Type declaration ​

Defined in ​

commission ​

Type declaration ​

Defined in ​

createdTime ​

Type declaration ​

Defined in ​

credit ​

Type declaration ​

Defined in ​

currency ​

Type declaration ​

Defined in ​

customerId ​

Type declaration ​

Defined in ​

email ​

Type declaration ​

Defined in ​

enabled ​

Type declaration ​

Defined in ​

equity ​

Type declaration ​

Defined in ​

id ​

Type declaration ​

Defined in ​

leverage ​

Type declaration ​

Defined in ​

login ​

Type declaration ​

Defined in ​

margin ​

Type declaration ​

Defined in ​

pnl ​

Type declaration ​

Defined in ​

readOnly ​

Type declaration ​

Defined in ​

server ​

Type declaration ​

Defined in ​

swaps ​

Type declaration ​

Defined in ​

taxes ​

Type declaration ​

Defined in ​

tradingPlatform ​

Type declaration ​

Defined in ​

Interface: AffiliateApiTradingAccountsModelDefinition

Hierarchy

Properties

balance

Type declaration

Defined in

commission

Type declaration

Defined in

createdTime

Type declaration

Defined in

credit

Type declaration

Defined in

currency

Type declaration

Defined in

customerId

Type declaration

Defined in

email

Type declaration

Defined in

enabled

Type declaration

Defined in

equity

Type declaration

Defined in

id

Type declaration

Defined in

leverage

Type declaration

Defined in

login

Type declaration

Defined in

margin

Type declaration

Defined in

pnl

Type declaration

Defined in

readOnly

Type declaration

Defined in

server

Type declaration

Defined in

swaps

Type declaration

Defined in

taxes

Type declaration

Defined in

tradingPlatform

Type declaration

Defined in