GetAvtaleGiroOrders

Filter inputs

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BrickIds

Guid[]

Filter by an array of BrickIds. A BrickId is the internal ID of a transfer order.

 

 

CreatedDateFrom

DateTime

Filter on creation date, from this date.

 

 

CreatedDateTo

DateTime

Filter on creation date, up to this date.

 

 

CurrencyCodes

string[]

Filter by ISO codes of the currency in the order, for example, "NOK".

 

 

ExternalReferences

string[]

Filter by external references that were set at the creation of the order.

 

 

BatchOrderIds

string[]

Filter by batch order BrickIds associated with the transfer orders.

 

 

AccountsIds

Guid[]

Filter by account BrickIds associated with the transfer orders.

 

 

AvtaleGiroOrderStatuses

string[]

Filter on the current state of the order. The states can be found in the back office GUI of BFS by navigating to SystemData→Workflows and then viewing the workflow for this order type.

 

 

TransferReceiverIds

Guid[]

Filter by transfer receiver BrickIds connected to the transfer orders.

 

 

SettlementDateFrom

DateTime

Filter on settlement date, from this date.

 

 

SettlementDateTo

DateTime

Filter on settlement date, up to this date.

 

 

TransferOrderTypeKeys

string[]

Filter by the transfer order types.

 

 

AvtaleGiroOrderNumbers

string[]

Filter by transfer order numbers.

 

 

AvtaleGiroResponseCodes

string[]

Filter by transfer order comment codes.

 

 

Response rows (Array) inherits from EntityBase

Name

Type

Description

Available from version

Name

Type

Description

Available from version

BrickId

Guid

The BrickId (unique id) of the account type

 

CreatedDate

DateTime

The timestamp of when the order was created

 

TransferOrderTypeKey

string

The name of the order type

 

AccountId

Guid

The BrickId of the associated accout for the order

 

CashAmount

decimal

The amount of the order

 

CurrencyCode

string

The ISO-code of the currency in the order, for example "NOK"

 

AvtaleGiroOrderStatus

string

The current state of the order as described by the workflow

 

AvtaleGiroOrderNumber

string

The order number of the transfer order

 

SettlementDate

DateTime

The date of when the order was settled

 

ExternalReference

string

The external reference that was set at the creation of the order

 

BatchOrderNumber

string

The order number of the associated batch order if the transfer order is associated to one

 

TransferReceiverId

Guid

The BrickId of the TransferReceiver

 

AvtaleGiroResponseCode

string

The comment code of the order

 

RecurringOrderTemplateIds

Guid[]

The BrickIds of the associated recurring order template/s

 

Code examples

XML - Get all AvtaleGiroOrders from a BFS instance
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> <GetAvtaleGiroOrders xmlns="http://tempuri.org/"> <req> <Credentials> <UserName>{{username}}</UserName> <Password>{{password}}</Password> </Credentials> <identify>{{identify}}</identify> <Args> </Args> <Fields> <BrickId>true</BrickId> <CreatedDate>true</CreatedDate> <SettlementDate>true</SettlementDate> <CashAmount>true</CashAmount> <AvtaleGiroOrderStatus>true</AvtaleGiroOrderStatus> <CurrencyCode>true</CurrencyCode> <AvtaleGiroOrderNumber>true</AvtaleGiroOrderNumber> <ExternalReference>true</ExternalReference> <AccountId>true</AccountId> <BatchOrderNumber>true</BatchOrderNumber> <TransferOrderTypeKey>true</TransferOrderTypeKey> <TransferReceiverId>true</TransferReceiverId> <AvtaleGiroResponseCode>true</AvtaleGiroResponseCode> <RecurringOrderTemplateIds>true</RecurringOrderTemplateIds> </Fields> </req> </GetAvtaleGiroOrders> </soap:Body> </soap:Envelope>

 

Terms of License
Change Policy
© 2009 - 2024 Huddlestock Technologies AB All rights reserved