API

Logistics APIs

GET system/reports/108454/result-set

Bank Balances and Movements - By Date & Bank

HTTP method GET
URI https://api.rambase.net/system/reports/108454/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5097, version 6

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.

$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.

ConfirmedDeliveryDate Date Confirmed date of delivery. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId Integer Customer identifier.
ProductId Integer Product identifier.
ProductName String Name of the product.
PurchaseOrderConfirmedDeliveryDate Date Confirmed delivery date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PurchaseOrderCurrency String Three character code following the ISO 4217 standard.
PurchaseOrderId Integer Identifier of the object.
PurchaseOrderItemId Integer Item-number of the object.
PurchaseOrderRemainingQuantity Decimal Remaining number of units to be forwarded.
PurchaseOrderRequestedDeliveryDate Date The delivery date as requested by the buyer/purchaser. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PurchaseOrderType String Type of object.
RequestedDeliveryDate Date The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SalesOrderId Integer Sales order identifier.
SalesOrderItemId Integer Sales order item identifier.
SupplierId Integer RamBase supplier identifier.

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

ConfirmedDeliveryDate Date Confirmed date of delivery
CustomerId Integer Customer identifier
ProductId Integer Product identifier
ProductName String Name of the product
PurchaseOrderConfirmedDeliveryDate Date Confirmed delivery date
PurchaseOrderCurrency String Three character code following the ISO 4217 standard
PurchaseOrderId Integer Identifier of the object
PurchaseOrderItemId Integer Item-number of the object
PurchaseOrderRemainingQuantity Decimal Remaining number of units to be forwarded
PurchaseOrderRequestedDeliveryDate Date The delivery date as requested by the buyer/purchaser
PurchaseOrderType String Type of object
RequestedDeliveryDate Date The delivery date as requested by the customer
SalesOrderId Integer Sales order identifier
SalesOrderItemId Integer Sales order item identifier
SupplierId Integer RamBase supplier identifier

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 the sales order item (0-9).

Possible domain values can be found here

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

Sales order item reference

>
6
                    <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
7
                    <SalesOrder
SalesOrder

Sales order reference

>
8
                         <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
9
                         <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
10
                    </SalesOrder>
11
                    <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
12
               </SalesOrderItem>
13
               <Product
Product

Product reference

>
14
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
15
                    <Name
Name

Name of the product

>{String}</Name>
16
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
17
               </Product>
18
               <ProductCustomField1
ProductCustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</ProductCustomField1>
19
               <Quantity
Quantity

Number of units ordered

>{Decimal}</Quantity>
20
               <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

>{Decimal}</RemainingQuantity>
21
               <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
22
               <ConvertedRemainingAmount
ConvertedRemainingAmount

Total remaining amount in company currency.

>{Decimal}</ConvertedRemainingAmount>
23
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
24
               <RemainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

>{Decimal}</RemainingAmount>
25
               <ConvertedLandedCost
ConvertedLandedCost

Gross landed cost multiplied with quantity of the item (converted to local currencies)

>{Decimal}</ConvertedLandedCost>
26
               <OriginalSalesOrderDate
OriginalSalesOrderDate

Date from original (first) Sales Order

>{Date}</OriginalSalesOrderDate>
27
               <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer

>{Date}</RequestedDeliveryDate>
28
               <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery

>{Date}</ConfirmedDeliveryDate>
29
               <Customer
Customer

Customer reference

>
30
                    <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
31
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
32
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
33
               </Customer>
34
               <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

>
35
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

>{String}</FinanceProjectLink>
38
               </FinanceProject>
39
               <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
40
               <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
41
               <PurchaseOrderStatus
PurchaseOrderStatus

Status of the Supplier item

>{Integer}</PurchaseOrderStatus>
42
               <PurchaseOrderItem
PurchaseOrderItem

Purchase order item reference

>
43
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
44
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
45
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
46
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
47
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
48
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
49
               </PurchaseOrderItem>
50
               <PurchaseOrderRemainingQuantity
PurchaseOrderRemainingQuantity

Remaining number of units to be forwarded

>{Decimal}</PurchaseOrderRemainingQuantity>
51
               <PurchaseOrderRequestedDeliveryDate
PurchaseOrderRequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

>{Date}</PurchaseOrderRequestedDeliveryDate>
52
               <PurchaseOrderConfirmedDeliveryDate
PurchaseOrderConfirmedDeliveryDate

Confirmed delivery date

>{Date}</PurchaseOrderConfirmedDeliveryDate>
53
               <Supplier
Supplier

Supplier reference

>
54
                    <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
55
                    <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
56
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
57
               </Supplier>
58
               <InitialPurchaseOrderItem
InitialPurchaseOrderItem

Initial purchase order item reference

>
59
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
60
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
61
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
62
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
63
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
64
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
65
               </InitialPurchaseOrderItem>
66
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
67
               <PurchaseOrderCurrency
PurchaseOrderCurrency

Three character code following the ISO 4217 standard

>{String}</PurchaseOrderCurrency>
68
               <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

>{String}</SuppliersReferenceNumber>
69
               <PurchaseOrderNote
PurchaseOrderNote

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</PurchaseOrderNote>
70
               <Inspect>
71
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
72
               </Inspect>
73
          </Row>
74
     </Rows>
75
     <Paging
Paging

Detailed paging information for this list.

>
76
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
79
          <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>
80
          <FirstPage
FirstPage

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

>{String}</FirstPage>
81
          <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>
82
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
83
          <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>
84
          <NextPage
NextPage

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

>{String}</NextPage>
85
          <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>
86
          <LastPage
LastPage

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

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

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

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

Status of the sales order item (0-9).

Possible domain values can be found here

": "{Integer}",
6
                    "salesOrderItem
SalesOrderItem

Sales order item reference

": {
7
                         "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
8
                         "salesOrder
SalesOrder

Sales order reference

": {
9
                              "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
10
                              "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
11
                         },
12
                         "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
13
                    },
14
                    "product
Product

Product reference

": {
15
                         "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
17
                         "productLink
ProductLink

Product reference

": "{String}"
18
                    },
19
                    "productCustomField1
ProductCustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
20
                    "quantity
Quantity

Number of units ordered

": "{Decimal}",
21
                    "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

": "{Decimal}",
22
                    "grossMargin
GrossMargin

Gross margin of the item.

": "{Decimal}",
23
                    "convertedRemainingAmount
ConvertedRemainingAmount

Total remaining amount in company currency.

": "{Decimal}",
24
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
25
                    "remainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

": "{Decimal}",
26
                    "convertedLandedCost
ConvertedLandedCost

Gross landed cost multiplied with quantity of the item (converted to local currencies)

": "{Decimal}",
27
                    "originalSalesOrderDate
OriginalSalesOrderDate

Date from original (first) Sales Order

": "{Date}",
28
                    "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer

": "{Date}",
29
                    "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery

": "{Date}",
30
                    "customer
Customer

Customer reference

": {
31
                         "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
33
                         "customerLink
CustomerLink

Customer reference

": "{String}"
34
                    },
35
                    "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

": {
36
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

": "{String}",
38
                         "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
39
                    },
40
                    "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
41
                    "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
42
                    "purchaseOrderStatus
PurchaseOrderStatus

Status of the Supplier item

": "{Integer}",
43
                    "purchaseOrderItem
PurchaseOrderItem

Purchase order item reference

": {
44
                         "itemId
ItemId

Item-number of the object

": "{Integer}",
45
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
46
                         "objectType
ObjectType

Type of object

": "{String}",
47
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
48
                         "objectLink
ObjectLink

API reference to the object

": "{String}",
49
                         "itemLink
ItemLink

API reference to the item

": "{String}"
50
                    },
51
                    "purchaseOrderRemainingQuantity
PurchaseOrderRemainingQuantity

Remaining number of units to be forwarded

": "{Decimal}",
52
                    "purchaseOrderRequestedDeliveryDate
PurchaseOrderRequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

": "{Date}",
53
                    "purchaseOrderConfirmedDeliveryDate
PurchaseOrderConfirmedDeliveryDate

Confirmed delivery date

": "{Date}",
54
                    "supplier
Supplier

Supplier reference

": {
55
                         "supplierId
SupplierId

RamBase supplier identifier

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

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
57
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
58
                    },
59
                    "initialPurchaseOrderItem
InitialPurchaseOrderItem

Initial purchase order item reference

": {
60
                         "itemId
ItemId

Item-number of the object

": "{Integer}",
61
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
62
                         "objectType
ObjectType

Type of object

": "{String}",
63
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
64
                         "objectLink
ObjectLink

API reference to the object

": "{String}",
65
                         "itemLink
ItemLink

API reference to the item

": "{String}"
66
                    },
67
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",
68
                    "purchaseOrderCurrency
PurchaseOrderCurrency

Three character code following the ISO 4217 standard

": "{String}",
69
                    "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

": "{String}",
70
                    "purchaseOrderNote
PurchaseOrderNote

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
71
                    "inspect": {
72
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
73
                    }
74
               }
75
          ]
76
     }
77
}

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