API

Finance APIs

GET system/reports/100435/result-set?bankStatementId={bankStatementId}&bankAccountId={bankAccountId}

Overview of bank statement reconciliations

Report name Bank statement reconciliation
Report identifier 100435
HTTP method GET
URI https://api.rambase.net/system/reports/100435/result-set?bankStatementId={bankStatementId}&bankAccountId={bankAccountId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6531, version 23

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.

bankStatementId Integer, optional Bank statement identifier

Minimum: 100000
bankAccountId Integer, optional Bank account identifier

Minimum: 100
$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.

BankAmount Decimal Bank statement amount.
PaymentAmount Decimal Total amount.
PaymentId Integer Payment identifier.
ReconciliationId Integer Reconciliation identifier of the bank statement.
ReconciliationMethod String Method of the reconciliation.
Status Integer Status of bank statement.

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

BankAmount Decimal Bank statement amount
PaymentAmount Decimal Total amount
PaymentId Integer Payment identifier
ReconciliationId Integer Reconciliation identifier of the bank statement
ReconciliationMethod String Method of the reconciliation
Status Integer Status of bank statement

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
<Report>
2
     <Rows>
3
          <Row>
4
               <Status
Status

Status of bank statement transaction

Possible domain values can be found here

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

Bank statement transaction reference

>
6
                    <TransactionId
TransactionId

Transaction identifier of the bank statement

>{Integer}</TransactionId>
7
                    <ApprovedBy
ApprovedBy

The user who has approved the bank statement transaction

>
8
                         <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
12
                    </ApprovedBy>
13
                    <BankStatement
BankStatement

Bank statement reference

>
14
                         <BankStatementId
BankStatementId

Bank statement identifier

>{Integer}</BankStatementId>
15
                         <BankStatementLink
BankStatementLink

Bank statement reference

>{String}</BankStatementLink>
16
                    </BankStatement>
17
                    <Totals
Totals

Total amounts

>
18
                         <Currency
Currency

Three character code following the ISO 4217 standard

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

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

Transaction amount

>{Decimal}</BankAmount>
20
                    </Totals>
21
                    <TransactionLink
TransactionLink

Bank statement transaction reference

>{String}</TransactionLink>
22
               </Transaction>
23
               <Payment
Payment

Payment reference

>
24
                    <PaymentId
PaymentId

Payment identifier

>{Integer}</PaymentId>
25
                    <Totals
Totals

Total amounts

>
26
                         <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Payment.Totals.Currency in your request URI to get this field

>{String}</Currency>
27
                         <TotalAmount
TotalAmount

Total amount

>{Decimal}</TotalAmount>
28
                    </Totals>
29
                    <PaymentLink
PaymentLink

Payment reference

>{String}</PaymentLink>
30
               </Payment>
31
               <Reconciliation
Reconciliation

Bank statement reconciliation reference

>
32
                    <ReconciliationId
ReconciliationId

Reconciliation identifier of the bank statement

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

Method of the reconciliation

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

The user who has reconciled the bank statement transaction

>
35
                         <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
39
                    </ReconciledBy>
40
               </Reconciliation>
41
               <Totals
Totals

Total amounts

>
42
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
43
                    <DeviationAmount
DeviationAmount

Total deviation amount

>{Decimal}</DeviationAmount>
44
               </Totals>
45
               <Inspect>
46
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
47
               </Inspect>
48
          </Row>
49
     </Rows>
50
     <Aggregated
Aggregated

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

>
51
          <Transaction
Transaction

Bank statement transaction reference

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

>
52
               <Totals
Totals

Total amounts

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

>
53
                    <BankAmount
BankAmount

Transaction amount

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

>{Decimal}</BankAmount>
54
               </Totals>
55
          </Transaction>
56
          <Payment
Payment

Payment reference

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

>
57
               <Totals
Totals

Total amounts

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

>
58
                    <TotalAmount
TotalAmount

Total amount

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

>{Decimal}</TotalAmount>
59
               </Totals>
60
          </Payment>
61
          <Totals
Totals

Total amounts

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

>
62
               <DeviationAmount
DeviationAmount

Total deviation amount

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

>{Decimal}</DeviationAmount>
63
          </Totals>
64
     </Aggregated>
65
     <Paging
Paging

Detailed paging information for this list.

>
66
          <PageSize
PageSize

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

>{Integer}</PageSize>
67
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
68
          <Page
Page

Page index

>{Integer}</Page>
69
          <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>
70
          <FirstPage
FirstPage

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

>{String}</FirstPage>
71
          <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>
72
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
73
          <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>
74
          <NextPage
NextPage

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

>{String}</NextPage>
75
          <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>
76
          <LastPage
LastPage

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

>{String}</LastPage>
77
          <Size
Size

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

>{Integer}</Size>
78
     </Paging>
79
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of bank statement transaction

Possible domain values can be found here

": "{Integer}",
6
                    "transaction
Transaction

Bank statement transaction reference

": {
7
                         "transactionId
TransactionId

Transaction identifier of the bank statement

": "{Integer}",
8
                         "approvedBy
ApprovedBy

The user who has approved the bank statement transaction

": {
9
                              "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
13
                         },
14
                         "bankStatement
BankStatement

Bank statement reference

": {
15
                              "bankStatementId
BankStatementId

Bank statement identifier

": "{Integer}",
16
                              "bankStatementLink
BankStatementLink

Bank statement reference

": "{String}"
17
                         },
18
                         "totals
Totals

Total amounts

": {
19
                              "currency
Currency

Three character code following the ISO 4217 standard

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

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

Transaction amount

": "{Decimal}"
21
                         },
22
                         "transactionLink
TransactionLink

Bank statement transaction reference

": "{String}"
23
                    },
24
                    "payment
Payment

Payment reference

": {
25
                         "paymentId
PaymentId

Payment identifier

": "{Integer}",
26
                         "totals
Totals

Total amounts

": {
27
                              "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Payment.Totals.Currency in your request URI to get this field

": "{String}",
28
                              "totalAmount
TotalAmount

Total amount

": "{Decimal}"
29
                         },
30
                         "paymentLink
PaymentLink

Payment reference

": "{String}"
31
                    },
32
                    "reconciliation
Reconciliation

Bank statement reconciliation reference

": {
33
                         "reconciliationId
ReconciliationId

Reconciliation identifier of the bank statement

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

Method of the reconciliation

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

The user who has reconciled the bank statement transaction

": {
36
                              "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
40
                         }
41
                    },
42
                    "totals
Totals

Total amounts

": {
43
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
44
                         "deviationAmount
DeviationAmount

Total deviation amount

": "{Decimal}"
45
                    },
46
                    "inspect": {
47
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
48
                    }
49
               }
50
          ],
51
          "aggregated
Aggregated

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

": {
52
               "transaction
Transaction

Bank statement transaction reference

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

": {
53
                    "totals
Totals

Total amounts

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

": {
54
                         "bankAmount
BankAmount

Transaction amount

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

": "{Decimal}"
55
                    }
56
               },
57
               "payment
Payment

Payment reference

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

": {
58
                    "totals
Totals

Total amounts

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

": {
59
                         "totalAmount
TotalAmount

Total amount

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

": "{Decimal}"
60
                    }
61
               },
62
               "totals
Totals

Total amounts

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

": {
63
                    "deviationAmount
DeviationAmount

Total deviation amount

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

": "{Decimal}"
64
               }
65
          }
66
     }
67
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type