API

Finance APIs

GET system/reports/100033/result-set?BankAccountId={BankAccountId}&SortIndex={SortIndex}

Payment reconciliation report

Report name Payment reconciliation
Report identifier 100033
HTTP method GET
URI https://api.rambase.net/system/reports/100033/result-set?BankAccountId={BankAccountId}&SortIndex={SortIndex}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6534, version 11

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.

BankAccountId Integer, required Bank account identifier

Minimum: 100,
Maximum: 999
SortIndex Integer, required Sorting index of payment
$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.

AccountingPeriodId Integer Accounting period identifier.
AssigneeFirstName String First name of the user.
AssigneeId Integer User identifier. Available macros: currentUser()
AssigneeName String Name of the user.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
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()
GeneralLedgerAccountId Integer General ledger account identifier.
GeneralLedgerAccountName String Name of general ledger account.
GeneralLedgerAccountNumber String The account number of the general ledger account.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentId Integer Payment identifier.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemittanceHandling String Method of payment. Default value is retrieved from the supplier or customer.
Status Integer Status of payment.
SubTotalAmount Decimal Summary amount.
Type String Type of counterparty with whom the payment is related.

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

AccountingPeriodId Integer Accounting period identifier
AssigneeFirstName String First name of the user
AssigneeId Integer User identifier
AssigneeName String Name of the user
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CurrencyDate Date Currency date of the transaction
GeneralLedgerAccountId Integer General ledger account identifier
GeneralLedgerAccountName String Name of general ledger account
GeneralLedgerAccountNumber String The account number of the general ledger account
IssueDate Date Date when the document was issued.
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentId Integer Payment identifier
RegistrationDate Date Date of registration
RemittanceHandling String Method of payment. Default value is retrieved from the supplier or customer
Status Integer Status of payment
SubTotalAmount Decimal Summary amount
Type String Type of counterparty with whom the payment is related

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 payment

Possible domain values can be found here

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

Payment identifier

>{Integer}</PaymentId>
6
               <RemittanceHandling
RemittanceHandling

Method of payment. Default value is retrieved from the supplier or customer

>{String}</RemittanceHandling>
7
               <Type
Type

Type of counterparty with whom the payment is related

Possible domain values can be found here

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

>{String}</Type>
8
               <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
9
               <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
10
               <RegistrationDate
RegistrationDate

Date of registration

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

>{Date}</RegistrationDate>
11
               <CurrencyDate
CurrencyDate

Currency date of the transaction

>{Date}</CurrencyDate>
12
               <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

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

>{String}</Note>
13
               <PaymentLink
PaymentLink

Payment reference

>{String}</PaymentLink>
14
               <BankAccount
BankAccount

Bank account reference

>
15
                    <BankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

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

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

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

>{String}</IBAN>
18
                    <AccountNumber
AccountNumber

Account number used to identify the bank account

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

Currency used for the bank account

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

>{String}</Currency>
20
                    <BankAccountLink
BankAccountLink

Bank reference

>{String}</BankAccountLink>
21
               </BankAccount>
22
               <GeneralLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

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

>
23
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

>{Integer}</GeneralLedgerAccountId>
24
                    <AccountNumber
AccountNumber

The account number of the general ledger account

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

>{String}</AccountNumber>
25
                    <Name
Name

Name of general ledger account

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

>{String}</Name>
26
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

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

>{String}</GeneralLedgerAccountLink>
27
               </GeneralLedgerAccount>
28
               <AccountingPeriod
AccountingPeriod

Accounting period reference

>
29
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
30
                    <Period
Period

Accounting period

>{Integer}</Period>
31
                    <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
32
               </AccountingPeriod>
33
               <Assignee
Assignee

The user who has been assigned to work with this object.

>
34
                    <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
38
               </Assignee>
39
               <Totals
Totals

Total amounts

>
40
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
41
                    <OpeningBalance
OpeningBalance

Opening balance of bank statement

>{Decimal}</OpeningBalance>
42
                    <SubTotalAmount
SubTotalAmount

Summary amount

>{Decimal}</SubTotalAmount>
43
                    <ClosingBalance
ClosingBalance

Closing balance of bank statement

>{Decimal}</ClosingBalance>
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
          <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

>
52
               <OpeningBalance
OpeningBalance

Opening balance of bank statement

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}</OpeningBalance>
53
               <SubTotalAmount
SubTotalAmount

Summary 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}</SubTotalAmount>
54
               <ClosingBalance
ClosingBalance

Closing balance of bank statement

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}</ClosingBalance>
55
          </Totals>
56
     </Aggregated>
57
     <Paging
Paging

Detailed paging information for this list.

>
58
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
61
          <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>
62
          <FirstPage
FirstPage

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

>{String}</FirstPage>
63
          <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>
64
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
65
          <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>
66
          <NextPage
NextPage

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

>{String}</NextPage>
67
          <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>
68
          <LastPage
LastPage

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

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

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

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

Status of payment

Possible domain values can be found here

": "{Integer}",
6
                    "paymentId
PaymentId

Payment identifier

": "{Integer}",
7
                    "remittanceHandling
RemittanceHandling

Method of payment. Default value is retrieved from the supplier or customer

": "{String}",
8
                    "type
Type

Type of counterparty with whom the payment is related

Possible domain values can be found here

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

": "{String}",
9
                    "createdAt
CreatedAt

Date and time of creation

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

": "{Datetime}",
10
                    "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
11
                    "registrationDate
RegistrationDate

Date of registration

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

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

Currency date of the transaction

": "{Date}",
13
                    "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

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

": "{String}",
14
                    "paymentLink
PaymentLink

Payment reference

": "{String}",
15
                    "bankAccount
BankAccount

Bank account reference

": {
16
                         "bankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

": "{String}",
18
                         "iBAN
IBAN

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

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

": "{String}",
19
                         "accountNumber
AccountNumber

Account number used to identify the bank account

": "{String}",
20
                         "currency
Currency

Currency used for the bank account

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

": "{String}",
21
                         "bankAccountLink
BankAccountLink

Bank reference

": "{String}"
22
                    },
23
                    "generalLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

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

": {
24
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

": "{Integer}",
25
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

": "{String}",
26
                         "name
Name

Name of general ledger account

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

": "{String}",
27
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

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

": "{String}"
28
                    },
29
                    "accountingPeriod
AccountingPeriod

Accounting period reference

": {
30
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
31
                         "period
Period

Accounting period

": "{Integer}",
32
                         "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
33
                    },
34
                    "assignee
Assignee

The user who has been assigned to work with this object.

": {
35
                         "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
39
                    },
40
                    "totals
Totals

Total amounts

": {
41
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
42
                         "openingBalance
OpeningBalance

Opening balance of bank statement

": "{Decimal}",
43
                         "subTotalAmount
SubTotalAmount

Summary amount

": "{Decimal}",
44
                         "closingBalance
ClosingBalance

Closing balance of bank statement

": "{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
               "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
                    "openingBalance
OpeningBalance

Opening balance of bank statement

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}",
54
                    "subTotalAmount
SubTotalAmount

Summary 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
                    "closingBalance
ClosingBalance

Closing balance of bank statement

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}"
56
               }
57
          }
58
     }
59
}

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