Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuid[]Filter by array of BrickIds. BrickId is the internal id of a Business Transaction.

ReturnCalculationTypestring[]"Trade", "Transfer" or "Payment"
2.02.20160506
BusinessTransactionTypeIdsGuid[]Filter by transaction types.
2.03.01
AccountsGuid[]Filter by array of Accounts. This is the GUID of the Account which can be retrieved using GetAccounts.

AssetsGuid[]Filter by array of Assets. This is the GUID of the Asset (financial instrument) which can be retrieved using GetInstruments

AccountDimensionKeysstring[]A business transaction may consist of two account transactions, one in settle and one in trade.

AccountTypeKeysstring[]The account type of the account where the transaction was made
2.02
AmountAsset1Fromdecimal?
When used, both from AmountAsset1 and to AmountAsset1 should be provided in the request


2.02
AmountAsset1Todecimal?
AmountAsset2Fromdecimal?
When used, both from
AmountAsset2 and to AmountAsset2 should be provided in the request


2.02
AmountAsset2Todecimal?
TradeDateFromDateTime?
When used, both from date and to date should be provided in the request


TradeDateToDateTime?

SettlementDateFromDateTime?
When used, both from date and to date should be provided in the request


SettlementDateToDateTime?

SequenceNoFromInt


When used, both from sequence number and to sequence number should be provided in the request



2.02
SequenceNoToInt
CreatedDateFromDateTime?
When used, both from date and to date should be provided in the request


CreatedDateToDateTime?

BatchIdsGuid[]Filter by the id of transaction batches
2.03.01
TransactionReferencesstring[]Filter by array of transaction references
2.10

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuid[]The BrickId of the transaction
SequenceNointTransaction number
AccountGuidThe GUID of the account where the transaction was made
AccountTypeKeystringThe account type of the account where the transaction was made2.02
Leg1Dimensionsstring[]A business transaction may consist of two account transactions, one in settle and one in trade.
Leg2Dimensionsstring[]A business transaction may consist of two account transactions, one in settle and one in trade.
Asset1CurrencyCodestringThe currency code of the first asset in the transaction, the first leg of a trade so to speak
Asset2CurrencyCodestringThe currency code of the second asset in the transaction, the second leg of a trade so to speak
Asset1GuidThe GUID of the asset/financial instrument of the first leg of the transaction
Asset2GuidThe GUID of the asset/financial instrument of the second leg of the transaction
NameAsset1stringThe name of asset12.02
NameAsset2stringThe name of asset22.02
Asset1TypeKeystringThe type of asset12.02
Asset2TypeKeystringThe type of asset22.02
BusinessTransactionTypeKeystringThe type key of the transaction type that you can get from GetBusinessTransactionTypes
BusinessTransactionTypeGuidThe GUID of the transaction type that you can get from GetBusinessTransactionTypes
AmountAsset1decimalThe amount of the first leg of the transaction
AmountAsset2decimalThe amount of the second leg of the transaction
InstrumentNamestringThe name of Asset2
TradeDateDateTimeThe trade date of the transaction
SettlementDateDateTimeThe settlement date of the transaction
ValueDateDateTimeThe value date of the transaction
AccountingDateDateTimeThe accounting date of the transaction
CreatedDateDateTimeThe timestamp of when the transaction was created
IsCorrectedboolIf the transaction was corrected by another linked transaction
CorrectionCommentstringA comment made in conjunction with a correction
PricedoubleThe price of Asset 2
AcquisitionValuedoubleAcquisition Value
AcquisitionValueAccountCurrencydoubleThe Acquisition Value expressed in the accounts currency
ReturnCalculationTypestring"Trade", "Transfer" or "Payment"2.02.20160506
TransactionReferencestringThe reference text saved on a transaction2.02.20160708
SuperTransactionIdGuidThe BrickId of the parent transaction2.02.20160708
BatchIdGuidThe id of the transaction batch2.03.01


Code examples

C# - Get Business Transactions
//Use the GetBusinessTransactions method to get all Business Transactions between certain dates in the BFS instance and write
//the information in the console
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 accounttypes = client.GetBusinessTransactions(new BFSServiceReference.GetBusinessTransactionsRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS  
    
    Args = new GetBusinessTransactionArgs()
    {        
        TradeDateFrom = DateTime.Now.AddDays(-20),
        TradeDateTo = DateTime.Now,
        
    },
    Fields = new BFSServiceReference.GetBusinessTransactionFields()
    {
        SequenceNo = true,
        Account = true,       
        Asset1CurrencyCode = true,
        Asset2CurrencyCode = true,
        Asset1 = true,
        Asset2 = true,
        BusinessTransactionTypeKey = true,
        BusinessTransactionType = true,
        AmountAsset1 = true,
        AmountAsset2 = true,
        InstrumentName = true,
        TradeDate = true,
        SettlementDate = true,
        CreatedDate = true,
        IsCorrected = true,
        CorrectionComment = true,
        Price = true,
        AcquisitionValue = true,
        AcquisitionValueAccountCurrency = true,       
    },
});
foreach (var c in accounttypes.Result)
{
    Console.WriteLine(c.BrickId + "," + c.SequenceNo + "," 
        + c.Account
        + "," 
        + c.Asset1CurrencyCode
        + ","
        + c.Asset2CurrencyCode
        + ","
        + c.Asset1
        + ","
        + c.Asset2
        + ","
        + c.BusinessTransactionTypeKey
        + ","
        + c.BusinessTransactionType
        + ","
        + c.AmountAsset1
        + ","
        + c.AmountAsset2
        + ","
        + c.InstrumentName
        + ","
        + c.TradeDate
        + ","
        + c.SettlementDate
        + ","
        + c.CreatedDate
        + ","
        + c.IsCorrected
        + ","
        + c.CorrectionComment
        + ","
        + c.Price
        + ","
        + c.AcquisitionValue
        + ","
        + c.AcquisitionValueAccountCurrency
        );
}


Blog Posts


  • No labels