API

Rental APIs

GET system/reports/110044/result-set?customerName={customerName}&salesOrderId={salesOrderId}&recurringInvoicePlanId={recurringInvoicePlanId}&includeAllRevisions={includeAllRevisions}

Overview of the recurring invoice plan - COP

Report name Recurring invoice plan overview
Report identifier 110044
HTTP method GET
URI https://api.rambase.net/system/reports/110044/result-set?customerName={customerName}&salesOrderId={salesOrderId}&recurringInvoicePlanId={recurringInvoicePlanId}&includeAllRevisions={includeAllRevisions}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5482, version 15

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.

customerName String, optional Name of customer (name of company or surname/familyname/lastname of a person)
salesOrderId Integer, optional Sales order identifier

Minimum: 100000
recurringInvoicePlanId Integer, optional Rental plan identifier

Minimum: 100000
includeAllRevisions Boolean, optional Include all revisions
$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.

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).
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductUnitSerialNumber String Serial number.
RentalPlanId Integer Rental plan identifier.
SalesOrderId Integer Sales order identifier.
SalesOrderItemId Integer Sales order item identifier.
SalesOrderStatus Integer Status of sales order.
SellersReferenceNumber String Sellers reference number..

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

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)
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
ProductId Integer Product identifier
ProductName String Name of the product
ProductUnitSerialNumber String Serial number
RentalPlanId Integer Rental plan identifier
SalesOrderId Integer Sales order identifier
SalesOrderItemId Integer Sales order item identifier
SalesOrderStatus Integer Status of sales order
SellersReferenceNumber String Sellers reference number.

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
               <SalesOrderItem
SalesOrderItem

Sales order item reference

>
5
                    <SalesOrder
SalesOrder

Sales order reference

>
6
                         <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
8
                    </SalesOrder>
9
                    <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
10
                    <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
11
               </SalesOrderItem>
12
               <SalesOrderStatus
SalesOrderStatus

Status of sales order

Possible domain values can be found here

>{Integer}</SalesOrderStatus>
13
               <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>{String}</SellersReferenceNumber>
14
               <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
15
               <CustomersReferenceNumber
CustomersReferenceNumber

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

>{String}</CustomersReferenceNumber>
16
               <Customer
Customer

Customer reference

>
17
                    <CustomerId
CustomerId

Customer identifier

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

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

>{String}</Name>
19
                    <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
20
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
21
               </Customer>
22
               <RecurringInvoicePlanItem
RecurringInvoicePlanItem

Recurring invoice plan item reference

>
23
                    <RecurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

>
24
                         <RecurringInvoicePlanId
RecurringInvoicePlanId

Rental plan identifier

>{Integer}</RecurringInvoicePlanId>
25
                         <RecurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan refrence

>{String}</RecurringInvoicePlanLink>
26
                    </RecurringInvoicePlan>
27
                    <RecurringInvoicePlanItemId
RecurringInvoicePlanItemId

Item-/line-number of the recurring invoice plan

>{Integer}</RecurringInvoicePlanItemId>
28
                    <RecurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Recurring invoice plan item reference

>{String}</RecurringInvoicePlanItemLink>
29
               </RecurringInvoicePlanItem>
30
               <InitialRentalPlanItem
InitialRentalPlanItem

Recurring invoice plan item reference

>
31
                    <RecurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

>
32
                         <RecurringInvoicePlanId
RecurringInvoicePlanId

Initial rental plan id

>{Integer}</RecurringInvoicePlanId>
33
                         <RecurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan refrence

>{String}</RecurringInvoicePlanLink>
34
                    </RecurringInvoicePlan>
35
                    <RecurringInvoicePlanItemId
RecurringInvoicePlanItemId

Initial rental plan item id

>{Integer}</RecurringInvoicePlanItemId>
36
                    <RecurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Initial rental plan item reference

>{String}</RecurringInvoicePlanItemLink>
37
               </InitialRentalPlanItem>
38
               <Status
Status

Status of recurring invoice plan

Possible domain values can be found here

>{Integer}</Status>
39
               <ShippingAdviceItem
ShippingAdviceItem

Shipping advice item reference

>
40
                    <ShippingAdvice
ShippingAdvice

Shipping advice reference

>
41
                         <ShippingAdviceId
ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>
42
                         <ShippingAdviceLink
ShippingAdviceLink

Shipping advice reference

>{String}</ShippingAdviceLink>
43
                    </ShippingAdvice>
44
                    <ShippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

>{Integer}</ShippingAdviceItemId>
45
                    <ShippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

>{String}</ShippingAdviceItemLink>
46
               </ShippingAdviceItem>
47
               <PriceAgreement
PriceAgreement

Price agreement reference

>
48
                    <PriceAgreementId
PriceAgreementId

Price structure identifier

>{Integer}</PriceAgreementId>
49
                    <Description
Description

Price agreement description

>{String}</Description>
50
                    <PriceAgreementLink
PriceAgreementLink

Price agreement reference

>{String}</PriceAgreementLink>
51
               </PriceAgreement>
52
               <Product
Product

Product reference

>
53
                    <ProductId
ProductId

Product identifier

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

Name of the product

>{String}</Name>
55
                    <Description
Description

Description of the product

>{String}</Description>
56
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
57
               </Product>
58
               <ProductUnit
ProductUnit

Product unit reference

>
59
                    <ProductUnitId
ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>
60
                    <SerialNumber
SerialNumber

Serial number

>{String}</SerialNumber>
61
                    <ProductUnitLink
ProductUnitLink

Product unit reference

>{String}</ProductUnitLink>
62
               </ProductUnit>
63
          </Row>
64
     </Rows>
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
                    "salesOrderItem
SalesOrderItem

Sales order item reference

": {
6
                         "salesOrder
SalesOrder

Sales order reference

": {
7
                              "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
9
                         },
10
                         "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
11
                         "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
12
                    },
13
                    "salesOrderStatus
SalesOrderStatus

Status of sales order

Possible domain values can be found here

": "{Integer}",
14
                    "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

": "{String}",
15
                    "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
16
                    "customersReferenceNumber
CustomersReferenceNumber

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

": "{String}",
17
                    "customer
Customer

Customer reference

": {
18
                         "customerId
CustomerId

Customer identifier

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

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

": "{String}",
20
                         "firstname
Firstname

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
22
                    },
23
                    "recurringInvoicePlanItem
RecurringInvoicePlanItem

Recurring invoice plan item reference

": {
24
                         "recurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

": {
25
                              "recurringInvoicePlanId
RecurringInvoicePlanId

Rental plan identifier

": "{Integer}",
26
                              "recurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan refrence

": "{String}"
27
                         },
28
                         "recurringInvoicePlanItemId
RecurringInvoicePlanItemId

Item-/line-number of the recurring invoice plan

": "{Integer}",
29
                         "recurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Recurring invoice plan item reference

": "{String}"
30
                    },
31
                    "initialRentalPlanItem
InitialRentalPlanItem

Recurring invoice plan item reference

": {
32
                         "recurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

": {
33
                              "recurringInvoicePlanId
RecurringInvoicePlanId

Initial rental plan id

": "{Integer}",
34
                              "recurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan refrence

": "{String}"
35
                         },
36
                         "recurringInvoicePlanItemId
RecurringInvoicePlanItemId

Initial rental plan item id

": "{Integer}",
37
                         "recurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Initial rental plan item reference

": "{String}"
38
                    },
39
                    "status
Status

Status of recurring invoice plan

Possible domain values can be found here

": "{Integer}",
40
                    "shippingAdviceItem
ShippingAdviceItem

Shipping advice item reference

": {
41
                         "shippingAdvice
ShippingAdvice

Shipping advice reference

": {
42
                              "shippingAdviceId
ShippingAdviceId

Shipping advice identifier

": "{Integer}",
43
                              "shippingAdviceLink
ShippingAdviceLink

Shipping advice reference

": "{String}"
44
                         },
45
                         "shippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

": "{Integer}",
46
                         "shippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

": "{String}"
47
                    },
48
                    "priceAgreement
PriceAgreement

Price agreement reference

": {
49
                         "priceAgreementId
PriceAgreementId

Price structure identifier

": "{Integer}",
50
                         "description
Description

Price agreement description

": "{String}",
51
                         "priceAgreementLink
PriceAgreementLink

Price agreement reference

": "{String}"
52
                    },
53
                    "product
Product

Product reference

": {
54
                         "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
56
                         "description
Description

Description of the product

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

Product reference

": "{String}"
58
                    },
59
                    "productUnit
ProductUnit

Product unit reference

": {
60
                         "productUnitId
ProductUnitId

Product unit identifier

": "{Integer}",
61
                         "serialNumber
SerialNumber

Serial number

": "{String}",
62
                         "productUnitLink
ProductUnitLink

Product unit reference

": "{String}"
63
                    }
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