Finance APIs
Bank Balances and Movements - By Date & Bank
HTTP method | GET |
URI | https://api.rambase.net/system/reports/109498/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 5383, version 8 |
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.
fromPeriod Integer, optional |
Format: YYYYMM - default From period will be first period of current calendar year
Minimum: 190000, Maximum: 299999 |
toPeriod Integer, optional |
Format: YYYYMM - default To period will be current period
Minimum: 190000, Maximum: 299999 |
$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.
ConvertedNetAmount Decimal | Net Amount/{CUR}. |
Currency String | Three character code following the ISO 4217 standard. |
CustomerFirstName String | Secondary name of a company or firstname of a person. |
CustomerId Integer | Customer identifier. |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
DeliveryTerms String | Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer. |
GeneralLedgerAccountId Integer | General ledger account identifier. |
IssueDate Date | Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
NetAmount Decimal | Final item amount after deducting all discounts etc. |
Period Integer | The accounting period the object belongs to. Available macros: currentPeriod(), previousPeriod() |
SalesCreditNoteId Integer | Sales credit note identifier. |
SalesCreditNoteItemId Integer | Item-/line-number of the credit note. |
SalesInvoiceId Integer | Sales invoice identifier. |
SalesInvoiceItemId Integer | Item-/line-number of the invoice. |
SupplierCreditNoteId Integer | Supplier credit note identifier. |
SupplierCreditNoteItemId Integer | Item-/linenumber of supplier credit note. |
SupplierFirstName String | Firstname/givenname if the supplier is a person. |
SupplierId Integer | RamBase supplier identifier. |
SupplierInvoiceId Integer | Supplier invoice identifier. |
SupplierInvoiceItemId Integer | Item-/linenumber of supplier invoice. |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
VATCode String | Code that determines VAT rules used for VAT calculations. |
VATEntityRegistrationNumber String | VAT code identifier. |
VATPeriod Integer | Accounting period this VAT posting belongs to. Available macros: currentPeriod(), previousPeriod() |
Read more about filters and sorting on how to use sortable parameters
ConvertedNetAmount Decimal | Net Amount/{CUR} |
Currency String | Three character code following the ISO 4217 standard |
CustomerFirstName String | Secondary name of a company or firstname of a person |
CustomerId Integer | Customer identifier |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
DeliveryTerms String | Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer. |
GeneralLedgerAccountId Integer | General ledger account identifier |
IssueDate Date | Date when the document was issued. |
NetAmount Decimal | Final item amount after deducting all discounts etc. |
Period Integer | The accounting period the object belongs to |
SalesCreditNoteId Integer | Sales credit note identifier |
SalesCreditNoteItemId Integer | Item-/line-number of the credit note |
SalesInvoiceId Integer | Sales invoice identifier |
SalesInvoiceItemId Integer | Item-/line-number of the invoice |
SupplierCreditNoteId Integer | Supplier credit note identifier |
SupplierCreditNoteItemId Integer | Item-/linenumber of supplier credit note |
SupplierFirstName String | Firstname/givenname if the supplier is a person |
SupplierId Integer | RamBase supplier identifier |
SupplierInvoiceId Integer | Supplier invoice identifier |
SupplierInvoiceItemId Integer | Item-/linenumber of supplier invoice |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
VATCode String | Code that determines VAT rules used for VAT calculations. |
VATEntityRegistrationNumber String | VAT code identifier |
VATPeriod Integer | Accounting period this VAT posting belongs to |
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.
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>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>SalesInvoiceItem
Sales invoice item reference
>SalesInvoiceItemId
Item-/line-number of the invoice
>{Integer}</SalesInvoiceItemId>SalesInvoice
Sales invoice reference
>SalesInvoiceId
Sales invoice identifier
>{Integer}</SalesInvoiceId>SalesInvoiceLink
Sales invoice reference
>{String}</SalesInvoiceLink>SalesInvoiceItemLink
Sales invoice Item reference
>{String}</SalesInvoiceItemLink>SalesCreditNoteItem
Sales credit note item reference
>SalesCreditNoteItemId
Item-/line-number of the credit note
>{Integer}</SalesCreditNoteItemId>SalesCreditNote
Sales credit note reference
>SalesCreditNoteId
Sales credit note identifier
>{Integer}</SalesCreditNoteId>SalesCreditNoteLink
Sales credit note reference
>{String}</SalesCreditNoteLink>SalesCreditNoteItemLink
Sales credit note Item reference
>{String}</SalesCreditNoteItemLink>SupplierInvoiceItem
Identifier of the supplier invoice item
>SupplierInvoiceItemId
Item-/linenumber of supplier invoice
>{Integer}</SupplierInvoiceItemId>SupplierInvoice
Supplier invoice reference
>SupplierInvoiceId
Supplier invoice identifier
>{Integer}</SupplierInvoiceId>SupplierInvoiceLink
Supplier invoice reference
>{String}</SupplierInvoiceLink>SupplierInvoiceItemLink
Supplier invoice Item reference
>{String}</SupplierInvoiceItemLink>SupplierCreditNoteItem
Identifier of the supplier credit note item
SupplierCreditNoteItemId
Item-/linenumber of supplier credit note
>{Integer}</SupplierCreditNoteItemId>SupplierCreditNote
Supplier credit note reference
>SupplierCreditNoteId
Supplier credit note identifier
>{Integer}</SupplierCreditNoteId>SupplierCreditNoteLink
Supplier credit note reference
>{String}</SupplierCreditNoteLink>SupplierCreditNoteItemLink
Supplier credit note Item reference
>{String}</SupplierCreditNoteItemLink>IssueDate
Date when the document was issued.
>{Date}</IssueDate>Period
The accounting period the object belongs to
>{Integer}</Period>GeneralLedgerAccount
Identifier of the general ledger account
>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>Name
Name of general ledger account
>{String}</Name>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>VATCode
Identifier of the VAT code
>Code
Code that determines VAT rules used for VAT calculations.
>{String}</Code>Description
Description of VAT Code definition
>{String}</Description>VatCodeDefinitionLink
VAT code reference
>{String}</VatCodeDefinitionLink>VATPeriod
Accounting period this VAT posting belongs to
>{Integer}</VATPeriod>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>ConvertedNetAmount
Net Amount/{CUR}
>{Decimal}</ConvertedNetAmount>ShippedFromAddress
Shipped from address reference
>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Country
English name of country.
>{String}</Country>ShippingAddress
Shipping address reference
>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Country
English name of country.
>{String}</Country>DeliveryTerms
Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.
Possible domain values can be found here
>{String}</DeliveryTerms>VATEntity
Vat entity reference
>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
>{String}</VATRegistrationNumber>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Country
Country name of VAT entity
>{String}</Country>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>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>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}"VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",SalesInvoiceItem
Sales invoice item reference
": {SalesInvoiceItemId
Item-/line-number of the invoice
": "{Integer}",SalesInvoice
Sales invoice reference
": {SalesInvoiceId
Sales invoice identifier
": "{Integer}",SalesInvoiceLink
Sales invoice reference
": "{String}"SalesInvoiceItemLink
Sales invoice Item reference
": "{String}"SalesCreditNoteItem
Sales credit note item reference
": {SalesCreditNoteItemId
Item-/line-number of the credit note
": "{Integer}",SalesCreditNote
Sales credit note reference
": {SalesCreditNoteId
Sales credit note identifier
": "{Integer}",SalesCreditNoteLink
Sales credit note reference
": "{String}"SalesCreditNoteItemLink
Sales credit note Item reference
": "{String}"SupplierInvoiceItem
Identifier of the supplier invoice item
": {SupplierInvoiceItemId
Item-/linenumber of supplier invoice
": "{Integer}",SupplierInvoice
Supplier invoice reference
": {SupplierInvoiceId
Supplier invoice identifier
": "{Integer}",SupplierInvoiceLink
Supplier invoice reference
": "{String}"SupplierInvoiceItemLink
Supplier invoice Item reference
": "{String}"SupplierCreditNoteItem
Identifier of the supplier credit note item
SupplierCreditNoteItemId
Item-/linenumber of supplier credit note
": "{Integer}",SupplierCreditNote
Supplier credit note reference
": {SupplierCreditNoteId
Supplier credit note identifier
": "{Integer}",SupplierCreditNoteLink
Supplier credit note reference
": "{String}"SupplierCreditNoteItemLink
Supplier credit note Item reference
": "{String}"IssueDate
Date when the document was issued.
": "{Date}",Period
The accounting period the object belongs to
": "{Integer}",GeneralLedgerAccount
Identifier of the general ledger account
": {GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",Name
Name of general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"VATCode
Identifier of the VAT code
": {Code
Code that determines VAT rules used for VAT calculations.
": "{String}",Description
Description of VAT Code definition
": "{String}",VatCodeDefinitionLink
VAT code reference
": "{String}"VATPeriod
Accounting period this VAT posting belongs to
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",ConvertedNetAmount
Net Amount/{CUR}
": "{Decimal}",ShippedFromAddress
Shipped from address reference
": {Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Country
English name of country.
": "{String}"ShippingAddress
Shipping address reference
": {Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Country
English name of country.
": "{String}"DeliveryTerms
Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.
Possible domain values can be found here
": "{String}",VATEntity
Vat entity reference
": {VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",Country
Country name of VAT entity
": "{String}"TargetApplication
Application reference 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 |