Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inputs (Array[] of UpdateTransferOrderState to update)

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuid
Yes
TargetStatestring

The desired state to which the transfer order should be updated.

Available states:
AutomaticOrder_Rejected
AutomaticOrder_Active
AutomaticOrder_PendedCancel
AutomaticOrder_Cancelled
AutomaticOrder_ToBeCancelled
AutomaticOrder_Finished
AutomaticOrder_Placed
AutomaticOrder_PrePlace

Yes 
BusinessDateDateTime

 Business date is set as trade/settle date on the created transactions. Only used together with AutomaticOrder_Finished.

When finalizing an order, if the 'BusinessDate' is not specified, it will automatically be assigned the current date at the time of the request.



 CustodyAccountGuid

 On which custody account transactions will be created. Only used together with AutomaticOrder_Finished. 

When finalizing an order, if the 'CustodyAccount' is not specified, it will automatically be assigned the default custody account for the currency used for the transactions.








Outputs

NameTypeDescriptionAvailable from version

Entities

Array

All UpdateTransferOrderStates in the request is returned. And an array of Errors perUpdateTransferOrderStates .






Code examples

Code Block
languagexml
themeRDark
titleXML request example
linenumberstrue
collapsetrue
POST {{baseUrl}}
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:tns="http://tempuri.org/" 
    xmlns:s1="http://microsoft.com/wsdl/types/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/">
    <soap:Body>
        <UpdateTransferOrderStates xmlns="http://tempuri.org/">
            <req>
                <Credentials>
                    <UserName>{{username}}</UserName>
                    <Password>{{password}}</Password>
                </Credentials>
                <identify>{{identify}}</identify>
                <Entities>
                    <UpdateTransferOrderState>
                        <BrickId>202fb4d7-2175-4da7-894e-000000000000</BrickId>
                        <TargetState>AutomaticOrder_Finished</TargetState>
                        <BusinessDate>2024-04-10</BusinessDate>
                        <CustodyAccount>9ae1e10a-bd18-4e53-8757-000000000000</CustodyAccount>
                    </UpdateTransferOrderState>
                </Entities>
                <Fields>
                    <TargetState>true</TargetState>
                </Fields>
            </req>
        </UpdateTransferOrderStates>
    </soap:Body>
</soap:Envelope>

...