CreateBusinessTransaction
Inputs (Array of SuperTransactions) inherits from EntityBase
Name | Type | Description | Mandatory | Available as of version |
---|---|---|---|---|
BusinessTransactions | BusinessTransaction[] | See table below | Â | Â |
InsurancePolicy | Guid | The Guid of the insurance policy for the super transaction | Â | 2.02 |
InsuranceClaim | Guid | The Guid of the insurance claim for the super transaction | Â | 2.02 |
Batch | Guid | The Guid of the batch for the super transaction | Â | 2.09 |
BusinessEventId | Guid | The Guid of the business event that the super transaction should be connected to. By associating a super transaction to a business event it is possible to include them in various GUI views, for example for corporate actions or other events. | Â | 2.27 |
OrderId | Guild | The Guid of the order that the super transaction should be connected to. After associating a super transaction to a order, the business transactions inside will be shown with a direct link to the order in the admin UI: | Â | 2.40 |
NoteId | Guid | The Guid of the note that the super transaction should be connected to. When a link between a note and a transaction is specified then the transaction will be listed on the trade note generated into a PDF. | Â | 2.40 |
Inputs (Array of BusinessTransactions) inherits from EntityBase
CustomFields entered on BusinessTransactions are not being saved (use CustomFields on the SuperTransaction to store that type of data which then can be retrieved using https://bricknode.atlassian.net/wiki/spaces/API/pages/58916910 )
From version 2.39 the CustomFields you enter on the individual Business Transaction will be saved on that particular Business Transaction. It will as before be possible to add CustomFields on the Super Transaction aswell,
Name | Type | Description | Mandatory | Available as of version |
---|---|---|---|---|
BrickId | Guid | Not used. | Â | Â |
Account | Guid | The Guid of the account where the transaction should be created. Empty guid is not allowed | True | Â |
BusinessTransactionType | string | Empty string is not allowed | True | Â |
TransactionReference | string | Transaction reference (This will show on the customer front in the section called "Comment") | Â | Â |
Asset1 | Guid | The GUID of the asset/financial instrument of the first leg of the transaction | Â | Â |
Asset2 | Guid | The GUID of the asset/financial instrument of the second leg of the transaction | Â | Â |
AmountAsset1 | decimal | The amount of the first leg of the transaction. (Number of decimals allowed is controlled by the number of decimals defined on the Cash object, although minimum 2 and maximum 6 decimals as from version 2.14) | Â | Â |
AmountAsset2 | decimal | The amount of the second leg of the transaction | Â | Â |
CustodyAccountAsset1 | Guid | The internal id of the custody account of the first leg of the transaction Obsolete as of version 2.02. Transactions for custody accounts should be created as separate business transactions as of version 2.02. | Â | Â |
CustodyAccountAsset2 | Guid | The internal id of the custody account of the second leg of the transaction Obsolete as of version 2.02. Transactions for custody accounts should be created as separate business transactions as of version 2.02. | Â | Â |
TradeDate | DateTime | Trade date | Â | Â |
SettlementDate | DateTime | Settlement date | Â | Â |
ValueDate | DateTime | Value date | Â | Â |
Price | double | Price. Below zero is not allowed | Â | Â |
AcquisitionValue | double | Acquisition value | Â | Â |
AcquisitionValueAccountCurrency | double | The acquisition value expressed in the account currency. | Â | Â |
SettlementType | string | Settlementtype, could be "Internal" or "External". "Internal" is default. Obsolete as of version 2.02. Transactions for custody accounts should be created as separate business transactions as of version 2.02. | Â | Â |
ReconciliationStatus | ReconciliationStatus? | ReconciliationStatus is an Enum that can be: Reconciled, Ignored and Investigate. | Â | 2.42.3 2022-09-14 |
Response rows
Name | Type | Description | Available from version |
---|---|---|---|
Entities | Array | An array of SuperTransactions will be returned with individual error messages and their associated BusinessTransactions | 2023-01-XX |
 |  |  |  |
Code examples
C# - Create Business Transactions
//Create a business event for a deposit with four business transactions using the CreateBusinessTransaction method
var client = new BFSServiceReference.bfsapiSoapClient();
var credentials = new BFSServiceReference.Credentials()
{
UserName = bfsusername, //Username of administrative user in your instance of BFS
Password = bfspassword, //Password of the administrative user in your instance of BFS
};
var response = client.CreateBusinessTransactions(new BFSServiceReference.CreateBusinessTransactionRequest()
{
Credentials = credentials,
identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
Entities = new[]
{
new SuperTransaction()
{
BusinessTransactions = new BusinessTransaction[]
{
//Transaction for customer BFS-account
new BusinessTransaction()
{
Account = new Guid("cbfe4a0d-bf05-4a7e-bdc8-1ee809817bee"),
BusinessTransactionType = "Default_Transfer_Trade_Cash",
TransactionReference = "Test",
Asset1 = new Guid("21b0718c-bce9-4c6b-b1c9-520b65121ff6"),
AmountAsset1 = 100M,
//Since the transaction type is for only the Trade dimension as suggested by the transaction name
TradeDate = DateTime.Parse("2016-04-18")
},
//Transaction for customer BFS-account
new BusinessTransaction()
{
Account = new Guid("cbfe4a0d-bf05-4a7e-bdc8-1ee809817bee"),
BusinessTransactionType = "Default_Transfer_Settle_Cash",
TransactionReference = "Test",
Asset1 = new Guid("21b0718c-bce9-4c6b-b1c9-520b65121ff6"),
AmountAsset1 = 100M,
//Since the transaction type is for only the Settle dimension as suggested by the transaction name
SettlementDate = DateTime.Parse("2016-04-18"),
ValueDate = DateTime.Parse("2016-04-18")
},
//Transaction for house Custody account
new BusinessTransaction()
{
Account = new Guid("25c7b534-c2b6-47a9-a3df-1dcc88b1f49c"),
BusinessTransactionType = "Default_Transfer_Trade_Cash",
TransactionReference = "Test",
Asset1 = new Guid("21b0718c-bce9-4c6b-b1c9-520b65121ff6"),
AmountAsset1 = 100M,
//Since the transaction type is for only the Trade dimension as suggested by the transaction name
TradeDate = DateTime.Parse("2016-04-18")
},
//Transaction for house Custody account
new BusinessTransaction()
{
Account = new Guid("25c7b534-c2b6-47a9-a3df-1dcc88b1f49c"),
BusinessTransactionType = "Default_Transfer_Settle_Cash",
TransactionReference = "Test",
Asset1 = new Guid("21b0718c-bce9-4c6b-b1c9-520b65121ff6"),
AmountAsset1 = 100M,
//Since the transaction type is for only the Settle dimension as suggested by the transaction name
SettlementDate = DateTime.Parse("2016-04-18"),
ValueDate = DateTime.Parse("2016-04-18")
},
},
},
}
});
Console.WriteLine(response.Message);
Blog Posts
-
Creating business transactions
created by
Apr 18, 2016
-
Working with shorting and negative acquisition values via API
created by
Sept 27, 2022
Terms of License
Change Policy
© 2009 - 2024 Huddlestock Technologies AB All rights reserved