Updates.proto (Paritech.OMS2.Protocol)

Describes the update messages used by OMS2.

Messages

Describes a specialised adjustment applied to an asset

No	Field	Type	Description
10	Code	string	The code of the target symbol
11	Exchange	string	The exchange listing the target symbol
19	Value	BigNumber	The value to transfer. Positive or negative
20	Reason	string	A reason code for this adjustment

Describes a specialised adjustment applied to a cash balance

No	Field	Type	Label	Description
10	Currency	string		The currency being transferred
11	Pool	string	optional	The pool of funds being transacted. If omitted, transfer affects Balance/Unbooked
19	Value	BigNumber		The value to transfer. Positive or negative
20	Reason	string		A reason code for this adjustment
21	Settlement	SettlementStatus		The settlement status of the adjustment. If Value specified, assumes Booked

Identifies a Transaction

No	Field	Type	Description
1	Type	ClientTransactionType	The type of transaction
10	Details	TransactionDetails	The common transaction details
20	CashTransfer	CashTransfer	Cash transfer-specific details
21	AssetTransfer	AssetTransfer	Asset transfer-specific details
30	AssetAdjustment	AssetAdjustment	Asset adjustment-specific details
31	CashAdjustment	CashAdjustment	Cash adjustment-specific details

Defines an activity that occurred on an external system

No	Field	Type	Description
1	Version	ExternalActionVersion	The protocol version for this operation
2	Type	ExternalActionType	The type of operation being performed
10	Order	OrderState	The latest state of an Order
11	Update	OrderUpdate	The details of the Update
12	Trade	OrderTrade	The details of the Trade (single side only)
20	Transaction	TransactionDetails	The details of a cash or asset transfer
21	CashTransfer	CashTransfer	The details of a transfer of cash to/from an account (single side only)
22	AssetTransfer	AssetTransfer	The details of a transfer of assets to/from an account (single side only)

Defines an operation being performed to transform the state

No	Field	Type	Description
1	Version	OperationVersion	The protocol version for this operation
2	Type	OperationType	The type of operation being performed
10	Transform	Transform	The details of a system Transformation
11	AccountTransform	AccountTransform	The details of an Account transformation
20	OwnerDetails	OwnerDetails	The details of an Owner
21	OwnerTransform	OwnerTransform	The details of an Owner transformation
25	AccountDetails	AccountDetails	The details of an Account
30	ExchangeDetails	ExchangeDetails	The details of an Exchange
31	RequestStatus	RequestStatusDetails	The details of an Order Request Status
40	Permissions	Permissions	Describes the Permissions related to the operation
41	IdentitySource	IdentitySource	Describes the Identity Source related to the operation

Describes an update event

No	Field	Type	Description
1	Type	UpdateEventType	The type of update that occurred
2	UpdateAction	UpdateAction	The type of update to perform on a state-based record (eg: holding, order, request, etc)
10	Operation	Operation	The details of a system operation
11	Action	ExternalAction	The details of a new Exchange Action
12	ClientRequest	ClientRequest	The details of a new Client Request. Not populated by Request subscriptions
13	ClientRequestUpdate	ClientRequestUpdate	The update to an existing Client Request. Not populated by Request subscriptions
19	Status	FeedDetails	The updated status of a data feed
20	Holding	AssetPosition	The updated state of an Asset Position
21	Balance	CashPosition	The updated state of a Cash Position
22	Order	OrderState	The updated state of an Order
23	Request	ClientRequestState	The updated state of a Request. Populated by Request subscriptions
24	Transaction	ClientTransaction	The details of a Transaction (cash or assets)

Identifies the type of client transaction being requested

Name	Number	Description
ClientTransactionType_Unknown	0
ClientTransactionType_Trade	10	A trade includes a Cash and Asset transfer, targeting the same account
ClientTransactionType_Adjustment	11	An adjustment includes a Cash and Asset adjustment, targeting the same account
ClientTransactionType_AssetTransfer	20	A one-directional transfer of assets
ClientTransactionType_CashTransfer	21	A one-directional transfer of cash
ClientTransactionType_AssetAdjustment	30	A once-off asset adjustment
ClientTransactionType_CashAdjustment	31	A once-off cash adjustment

Identifies the action being performed

Name	Number	Description
ExternalActionType_Unknown	0	Unknown/invalid operation
ExternalActionType_Update	110	Update an Order
ExternalActionType_Replace	111	Replaces just the state of an Order
ExternalActionType_Trade	120	Update and Trade an Order
ExternalActionType_CashTransfer	200	Transfer of cash (balance)
ExternalActionType_AssetTransfer	210	Transfer of an asset (holdings)

Identifies the operational version

Name	Number	Description
ExternalActionVersion_Initial	0	Initial schema

Identifies the operation being performed

Name	Number	Description
OperationType_Unknown	0	Unknown/invalid operation
OperationType_Transform	100	Apply a Transform
OperationType_TransformAccount	110	Apply an Account Transform
OperationType_DefineOwner	200	Defines the details of an Owner
OperationType_UndefineOwner	201	Undefines an Owner and all attached records
OperationType_TransformOwner	210	Perform an Owner Transformation
OperationType_DefineAccount	250	Defines the details of an Account
OperationType_UndefineAccount	251	Undefines an Account. Does not remove any attached records
OperationType_DefineExchange	300	Defines the details of an Exchange
OperationType_UndefineExchange	301	Undefines an Exchange
OperationType_DefineRequestStatus	310	Defines the details of a Request Status
OperationType_UndefineRequestStatus	311	Undefines a Request Status
OperationType_DefinePermissions	400	Defines permissions for an identity
OperationType_UndefinePermissions	401	Removes permissions for an identity
OperationType_DefineIdentitySource	410	Defines an identity source
OperationType_UndefineIdentitySource	411	Undefines an identity source

Identifies the operational version

Name	Number	Description
OperationVersion_Initial	0	Initial schema

Identifies the action to perform on an updated record

Name	Number	Description
UpdateAction_Update	0	Default action, update/replace the existing state
UpdateAction_Remove	1	Remove the record state after updating

Identifies the type of update that has occurred

Name	Number	Description
UpdateEventType_Unknown	0	Unknown/invalid update type
UpdateEventType_Operation	10	Perform a system operation
UpdateEventType_Action	11	Report an Exchange Action
UpdateEventType_ClientRequest	12	Report an Client Request creation
UpdateEventType_ClientRequestUpdate	13	Report a Client Request update
UpdateEventType_Status	19	Update a feed status
UpdateEventType_Holding	20	Update a Holding
UpdateEventType_Balance	21	Update a Cash Balance
UpdateEventType_Order	22	Update an Order
UpdateEventType_Request	23	Update a Client Request
UpdateEventType_Transaction	24	Report a client transaction