Finance APIs

GET finance/bank-statements/{bankStatementId}/transactions

List of bank statement transactions

HTTP method	GET
URI	https://api.rambase.net/finance/bank-statements/{bankStatementId}/transactions
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {bankStatementId}	Bank statement identifier Integer, minimum 100000
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	5635, version 9

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ApprovedBy Integer	The user who has approved the bank statement transaction.
BankAmount Decimal	Transaction amount.
BankReference String	Reference from the bank.
BookingDate Date	Booking date of the bank statement transaction. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedAt Datetime	Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CurrencyDate Date	Currency date of the bank statement transaction. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
InternalMessage String	Internal message from the system.
PaymentMessage String	Message from the payment.
Status Integer	Status of bank statement.
TransactionId Integer	Transaction identifier of the bank statement.
TransactionReference String	Our internal reference.

Read more about filters and sorting on how to use sortable parameters

ApprovedBy Integer	The user who has approved the bank statement transaction
BankAmount Decimal	Transaction amount
BankReference String	Reference from the bank
BookingDate Date	Booking date of the bank statement transaction
CreatedAt Datetime	Date and time of creation
CurrencyDate Date	Currency date of the bank statement transaction
InternalMessage String	Internal message from the system
PaymentMessage String	Message from the payment
Status Integer	Status of bank statement
TransactionId Integer	Transaction identifier of the bank statement
TransactionReference String	Our internal reference

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <Transactions>
                                    

                                             <Transaction>
                                    

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<TransactionId

TransactionId

Transaction identifier of the bank statement

>{Integer}</TransactionId>

<Status

Status

Status of bank statement

Possible domain values can be found here

>{Integer}</Status>

<BookingDate

BookingDate

Booking date of the bank statement transaction

>{Date}</BookingDate>

<CurrencyDate

CurrencyDate

Currency date of the bank statement transaction

>{Date}</CurrencyDate>

<BankReference

BankReference

Reference from the bank

>{String}</BankReference>

<TransactionReference

TransactionReference

Our internal reference

>{String}</TransactionReference>

<PaymentMessage

PaymentMessage

Message from the payment

>{String}</PaymentMessage>

<InternalMessage

InternalMessage

Internal message from the system

>{String}</InternalMessage>

                                                  <Reconciliation>
                                    

<ReconciliationId

ReconciliationId

Reconciliation identifier of the bank statement

>{Integer}</ReconciliationId>

<ReconciliationMethod

ReconciliationMethod

Method of the reconciliation

>{String}</ReconciliationMethod>

<ReconciledBy

ReconciledBy

The user who has reconciled the bank statement transaction

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                       </ReconciledBy>
                                    

                                                       <ReconciliationBatchJob>
                                    

<BatchJobId

BatchJobId

Batch job identifier

>{Integer}</BatchJobId>

<BatchJobLink

BatchJobLink

Batch job reference

>{String}</BatchJobLink>

                                                       </ReconciliationBatchJob>
                                    

                                                  </Reconciliation>
                                    

<ApprovedBy

ApprovedBy

The user who has approved the bank statement transaction

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                  </ApprovedBy>
                                    

<Payments

Payments

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

<Payment

Payment

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

<PaymentId

PaymentId

Payment identifier

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

>{Integer}</PaymentId>

<Status

Status

Status of payment

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

>{Integer}</Status>

<PaymentLink

PaymentLink

Payment reference

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

>{String}</PaymentLink>

                                                       </Payment>
                                    

                                                  </Payments>
                                    

                                                  <Totals>
                                    

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<BankAmount

BankAmount

Transaction amount

>{Decimal}</BankAmount>

<PaymentAmount

PaymentAmount

Payment amount

>{Decimal}</PaymentAmount>

<DeviationAmount

DeviationAmount

Deviation amount

>{Decimal}</DeviationAmount>

                                                  </Totals>
                                    

<TransactionLink

TransactionLink

Bank statement transaction reference

>{String}</TransactionLink>

                                             </Transaction>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Transactions>
                                    

{

                                             "transactions": [
                                    

{

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"transactionId

TransactionId

Transaction identifier of the bank statement

": "{Integer}",

"status

Status

Status of bank statement

Possible domain values can be found here

": "{Integer}",

"bookingDate

BookingDate

Booking date of the bank statement transaction

": "{Date}",

"currencyDate

CurrencyDate

Currency date of the bank statement transaction

": "{Date}",

"bankReference

BankReference

Reference from the bank

": "{String}",

"transactionReference

TransactionReference

Our internal reference

": "{String}",

"paymentMessage

PaymentMessage

Message from the payment

": "{String}",

"internalMessage

InternalMessage

Internal message from the system

": "{String}",

                                                       "reconciliation": {
                                    

"reconciliationId

ReconciliationId

Reconciliation identifier of the bank statement

": "{Integer}",

"reconciliationMethod

ReconciliationMethod

Method of the reconciliation

": "{String}",

"reconciledBy

ReconciledBy

The user who has reconciled the bank statement transaction

": {

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

                                                            "reconciliationBatchJob": {
                                    

"batchJobId

BatchJobId

Batch job identifier

": "{Integer}",

"batchJobLink

BatchJobLink

Batch job reference

": "{String}"

}

},

"approvedBy

ApprovedBy

The user who has approved the bank statement transaction

": {

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

"payments

Payments

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

": [

{

"paymentId

PaymentId

Payment identifier

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

": "{Integer}",

"status

Status

Status of payment

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

": "{Integer}",

"paymentLink

PaymentLink

Payment reference

This field is greyed out because it is an expandable field. You have to add $expand=Transaction.Payments in your request URI to get this field

": "{String}"

}

],

                                                       "totals": {
                                    

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"bankAmount

BankAmount

Transaction amount

": "{Decimal}",

"paymentAmount

PaymentAmount

Payment amount

": "{Decimal}",

"deviationAmount

DeviationAmount

Deviation amount

": "{Decimal}"

},

"transactionLink

TransactionLink

Bank statement transaction reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101814 HTTP 404

Employee not found