Finance APIs
Bank Balances and Movements - By Date & Bank
| Report name | PAY Transactions (Registered) |
| Report identifier | 100157 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/100157/result-set |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4468, version 14 |
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.
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.
| $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.
| BankAccountId Integer | Bank account identifier. |
| Currency String | Payment Currency. |
| CurrencyAmount Decimal | Total paid amount. |
| CustomerId Integer | Customer identifier. |
| EmployeeId Integer | Employee identifier. |
| ExchangeRate Decimal | Payment Currency Rate. |
| Period Integer | The accounting period the object belongs to. |
| PostingDate Date | Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Status Integer | Status code of the the payment item. |
| SupplierId Integer | RamBase supplier identifier. |
| TransactionDate Date | Currency date of the transaction. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Read more about filters and sorting on how to use sortable parameters
| BankAccountId Integer | Bank account identifier |
| Currency String | Payment Currency |
| CurrencyAmount Decimal | Total paid amount |
| CustomerId Integer | Customer identifier |
| EmployeeId Integer | Employee identifier |
| ExchangeRate Decimal | Payment Currency Rate |
| Period Integer | The accounting period the object belongs to |
| PostingDate Date | Date when the document was issued. |
| Status Integer | Status code of the the payment item. |
| SupplierId Integer | RamBase supplier identifier |
| TransactionDate Date | Currency date of the transaction |
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.
Status
Status code of the the payment item.
>{Integer}</Status>PaymentItem
Payment item reference
>PaymentItemId
Item-/line-number of the payment.
>{Integer}</PaymentItemId>Payment
Payment reference
>PaymentId
Payment identifier
>{Integer}</PaymentId>PaymentLink
Payment reference
>{String}</PaymentLink>PaymentItemLink
Payment item reference
>{String}</PaymentItemLink>BankAccount
Bank account reference
>BankAccountId
Bank account identifier
>{Integer}</BankAccountId>AccountNumber
Account number used to identify the bank account
>{String}</AccountNumber>Name
Name of bank account
>{String}</Name>BankLink
Bank reference
>{String}</BankLink>Customer
Customer reference
>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>CustomerLink
Customer reference
>{String}</CustomerLink>Supplier
Supplier reference
>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Firstname/givenname if the supplier is a person
>{String}</FirstName>SupplierLink
Supplier reference
>{String}</SupplierLink>Employee
Employee reference
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>PostingDate
Date when the document was issued.
>{Date}</PostingDate>TransactionDate
Currency date of the transaction
>{Date}</TransactionDate>Period
The accounting period the object belongs to
>{Integer}</Period>Currency
Payment Currency
ExchangeRate
Payment Currency Rate
>{Decimal}</ExchangeRate>CurrencyAmount
Total paid amount
>{Decimal}</CurrencyAmount>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Filter
Filter used when inspecting a line in a report.
>{String}</Filter>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Status
Status code of the the payment item.
": "{Integer}",PaymentItem
Payment item reference
": {PaymentItemId
Item-/line-number of the payment.
": "{Integer}",Payment
Payment reference
": {PaymentId
Payment identifier
": "{Integer}",PaymentLink
Payment reference
": "{String}"PaymentItemLink
Payment item reference
": "{String}"BankAccount
Bank account reference
": {BankAccountId
Bank account identifier
": "{Integer}",AccountNumber
Account number used to identify the bank account
": "{String}",Name
Name of bank account
": "{String}",BankLink
Bank reference
": "{String}"Customer
Customer reference
": {CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"Supplier
Supplier reference
": {SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Firstname/givenname if the supplier is a person
": "{String}",SupplierLink
Supplier reference
": "{String}"Employee
Employee reference
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"PostingDate
Date when the document was issued.
": "{Date}",TransactionDate
Currency date of the transaction
": "{Date}",Period
The accounting period the object belongs to
": "{Integer}",Currency
Payment Currency
ExchangeRate
Payment Currency Rate
": "{Decimal}",CurrencyAmount
Total paid amount
": "{Decimal}",TargetApplication
Application reference when inspecting a line in a report.
": "{String}",Filter
Filter used when inspecting a line in a report.
": "{String}"
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 |