API

Finance APIs

GET finance/bank-statements/{bankStatementId}/transactions/{transactionId}?includeAllOpenItems={includeAllOpenItems}

Details about a specific transaction of an bank statement

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

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:
1
1

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.

includeAllOpenItems Boolean, optional Indicates if applicable payments should be reconciled with all open transactions
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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

Bank Integer Bank account identifier.
BankStatementReference String Bank statement reference.
CreatedBy Integer Identifier of the employee who created the payment.
Currency String Three character code following the ISO 4217 standard.
CurrencyDate Date Currency date of the transaction. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PaymentId Integer Payment identifier.
Period Integer Accounting period identifier. Available macros: currentPeriod(), previousPeriod()
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SortIndex Integer Sorting index of payment.
Status Integer Status of payment.
TotalAmount Decimal Total amount.

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

Bank Integer Bank account identifier
BankStatementReference String Bank statement reference
CreatedBy Integer Identifier of the employee who created the payment
Currency String Three character code following the ISO 4217 standard
CurrencyDate Date Currency date of the transaction
IssueDate Date Date when the document was issued.
PaymentId Integer Payment identifier
Period Integer Accounting period identifier
RegistrationDate Date Date of registration
SortIndex Integer Sorting index of payment
Status Integer Status of payment
TotalAmount Decimal Total amount

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:
1
<Transaction>
2
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
3
     <TransactionId
TransactionId

Transaction identifier of the bank statement

>{Integer}</TransactionId>
4
     <Status
Status

Status of bank statement

Possible domain values can be found here

>{Integer}</Status>
5
     <BookingDate
BookingDate

Booking date of the bank statement transaction

>{Date}</BookingDate>
6
     <CurrencyDate
CurrencyDate

Currency date of the bank statement transaction

>{Date}</CurrencyDate>
7
     <BankReference
BankReference

Reference from the bank

>{String}</BankReference>
8
     <TransactionReference
TransactionReference

Our internal reference

>{String}</TransactionReference>
9
     <PaymentMessage
PaymentMessage

Message from the payment

>{String}</PaymentMessage>
10
     <InternalMessage
InternalMessage

Internal message from the system

>{String}</InternalMessage>
11
     <Reconciliation>
12
          <ReconciliationId
ReconciliationId

Reconciliation identifier of the bank statement

>{Integer}</ReconciliationId>
13
          <ReconciliationMethod
ReconciliationMethod

Method of the reconciliation

>{String}</ReconciliationMethod>
14
          <ReconciledBy
ReconciledBy

The user who has reconciled the bank statement transaction

>
15
               <UserId
UserId

User identifier

>{Integer}</UserId>
16
               <Name
Name

Name of the user

>{String}</Name>
17
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
18
               <UserLink
UserLink

User reference

>{String}</UserLink>
19
          </ReconciledBy>
20
          <ReconciliationBatchJob>
21
               <BatchJobId
BatchJobId

Batch job identifier

>{Integer}</BatchJobId>
22
               <BatchJobLink
BatchJobLink

Batch job reference

>{String}</BatchJobLink>
23
          </ReconciliationBatchJob>
24
     </Reconciliation>
25
     <ApprovedBy
ApprovedBy

The user who has approved the bank statement transaction

>
26
          <UserId
UserId

User identifier

>{Integer}</UserId>
27
          <Name
Name

Name of the user

>{String}</Name>
28
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
29
          <UserLink
UserLink

User reference

>{String}</UserLink>
30
     </ApprovedBy>
31
     <Payments
Payments

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

>
32
          <Payment
Payment

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

>
33
               <PaymentId
PaymentId

Payment identifier

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

>{Integer}</PaymentId>
34
               <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=Payments in your request URI to get this field

>{Integer}</Status>
35
               <PaymentLink
PaymentLink

Payment reference

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

>{String}</PaymentLink>
36
          </Payment>
37
     </Payments>
38
     <Totals>
39
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
40
          <BankAmount
BankAmount

Transaction amount

>{Decimal}</BankAmount>
41
          <PaymentAmount
PaymentAmount

Payment amount

>{Decimal}</PaymentAmount>
42
          <DeviationAmount
DeviationAmount

Deviation amount

>{Decimal}</DeviationAmount>
43
     </Totals>
44
     <ApplicablePayments
ApplicablePayments

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

>
45
          <TotalPaymentAmount
TotalPaymentAmount

Aggregated total amount of bank statement's applicable payments.

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

>{Decimal}</TotalPaymentAmount>
46
     </ApplicablePayments>
47
</Transaction>
1
{
2
     "transaction": {
3
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
4
          "transactionId
TransactionId

Transaction identifier of the bank statement

": "{Integer}",
5
          "status
Status

Status of bank statement

Possible domain values can be found here

": "{Integer}",
6
          "bookingDate
BookingDate

Booking date of the bank statement transaction

": "{Date}",
7
          "currencyDate
CurrencyDate

Currency date of the bank statement transaction

": "{Date}",
8
          "bankReference
BankReference

Reference from the bank

": "{String}",
9
          "transactionReference
TransactionReference

Our internal reference

": "{String}",
10
          "paymentMessage
PaymentMessage

Message from the payment

": "{String}",
11
          "internalMessage
InternalMessage

Internal message from the system

": "{String}",
12
          "reconciliation": {
13
               "reconciliationId
ReconciliationId

Reconciliation identifier of the bank statement

": "{Integer}",
14
               "reconciliationMethod
ReconciliationMethod

Method of the reconciliation

": "{String}",
15
               "reconciledBy
ReconciledBy

The user who has reconciled the bank statement transaction

": {
16
                    "userId
UserId

User identifier

": "{Integer}",
17
                    "name
Name

Name of the user

": "{String}",
18
                    "firstName
FirstName

First name of the user

": "{String}",
19
                    "userLink
UserLink

User reference

": "{String}"
20
               },
21
               "reconciliationBatchJob": {
22
                    "batchJobId
BatchJobId

Batch job identifier

": "{Integer}",
23
                    "batchJobLink
BatchJobLink

Batch job reference

": "{String}"
24
               }
25
          },
26
          "approvedBy
ApprovedBy

The user who has approved the bank statement transaction

": {
27
               "userId
UserId

User identifier

": "{Integer}",
28
               "name
Name

Name of the user

": "{String}",
29
               "firstName
FirstName

First name of the user

": "{String}",
30
               "userLink
UserLink

User reference

": "{String}"
31
          },
32
          "payments
Payments

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

": [
33
               {
34
                    "paymentId
PaymentId

Payment identifier

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

": "{Integer}",
35
                    "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=Payments in your request URI to get this field

": "{Integer}",
36
                    "paymentLink
PaymentLink

Payment reference

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

": "{String}"
37
               }
38
          ],
39
          "totals": {
40
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
41
               "bankAmount
BankAmount

Transaction amount

": "{Decimal}",
42
               "paymentAmount
PaymentAmount

Payment amount

": "{Decimal}",
43
               "deviationAmount
DeviationAmount

Deviation amount

": "{Decimal}"
44
          },
45
          "applicablePayments
ApplicablePayments

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

": {
46
               "totalPaymentAmount
TotalPaymentAmount

Aggregated total amount of bank statement's applicable payments.

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

": "{Decimal}"
47
          }
48
     }
49
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found
Error 104526 HTTP 404 Bank statement item not found