API

Rental APIs

GET system/reports/110095/result-set?customerId={customerId}&recurringInvoicePlanId={recurringInvoicePlanId}&invoiceIssueDateFrom={invoiceIssueDateFrom}&invoiceIssueDateTo={invoiceIssueDateTo}&onlyCurrentMonth={onlyCurrentMonth}&recurringInvoicePlanItemNotInvoiced={recurringInvoicePlanItemNotInvoiced}

A list of recurring billing periods including recurring plan, customer, and product details. Can be filtered by customer account number, recurring invoice plan number and date range of sales invoicing.

Report name Recurring invoice periods
Report identifier 110095
HTTP method GET
URI https://api.rambase.net/system/reports/110095/result-set?customerId={customerId}&recurringInvoicePlanId={recurringInvoicePlanId}&invoiceIssueDateFrom={invoiceIssueDateFrom}&invoiceIssueDateTo={invoiceIssueDateTo}&onlyCurrentMonth={onlyCurrentMonth}&recurringInvoicePlanItemNotInvoiced={recurringInvoicePlanItemNotInvoiced}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5485, version 22

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.

customerId Integer, optional Customer identifier

Minimum: 10000
recurringInvoicePlanId Integer, optional Recurring invoice plan identifier

Minimum: 100000
invoiceIssueDateFrom Date, optional Sales invoice issue date from
invoiceIssueDateTo Date, optional Sales invoice issue date to
onlyCurrentMonth Boolean, optional Sales invoice date condition restricted to the current month

Default: True
recurringInvoicePlanItemNotInvoiced Boolean, optional If True, show only the recurring invoice plan items that has not been invoiced yet.

Default: False
$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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

BaseDate Date A date from which invoices will start to be generated from. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
BaseDateAdvanceDays Integer Number of days to advance invoicing from base date.
Currency String Recurring invoice plan currency.
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.
PeriodEndDate Date End date of an invoice period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PeriodStartDate Date Start date of an invoice period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Decimal Quantity of invoiced item.
RecurringAmount Decimal Accumulated value of recurring amounts.
RecurringInvoicePlanId Integer Recurring invoice plan identifier.
SalesInvoiceId Integer Sales order identifier.
SalesInvoiceIssueDate Date Date of an invoice. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of recurring invoice period.

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

BaseDate Date A date from which invoices will start to be generated from
BaseDateAdvanceDays Integer Number of days to advance invoicing from base date
Currency String Recurring invoice plan currency
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.
PeriodEndDate Date End date of an invoice period
PeriodStartDate Date Start date of an invoice period.
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
Quantity Decimal Quantity of invoiced item
RecurringAmount Decimal Accumulated value of recurring amounts
RecurringInvoicePlanId Integer Recurring invoice plan identifier
SalesInvoiceId Integer Sales order identifier
SalesInvoiceIssueDate Date Date of an invoice
Status Integer Status of recurring invoice period

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 recurring invoice period

Possible domain values can be found here

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

Recurring invoice plan item reference

>
6
                    <RecurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

>
7
                         <RecurringInvoicePlanId
RecurringInvoicePlanId

Recurring invoice plan identifier

>{Integer}</RecurringInvoicePlanId>
8
                    </RecurringInvoicePlan>
9
                    <RecurringInvoicePlanItemId
RecurringInvoicePlanItemId

Recurring invoice plan item identifier

>{Integer}</RecurringInvoicePlanItemId>
10
                    <Title
Title

A short description of the recurring invoice plan

>{String}</Title>
11
                    <RecurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Reference to the recurring invoice plan item.

>{String}</RecurringInvoicePlanItemLink>
12
               </RecurringInvoicePlanItem>
13
               <CustomersReference
CustomersReference

Customers reference. Typically a person.

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

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

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

Customer reference

>
16
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
19
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
20
               </Customer>
21
               <Currency
Currency

Recurring invoice plan currency

>{String}</Currency>
22
               <Product
Product

Product reference

>
23
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductLink>
27
               </Product>
28
               <CurrentPriceStep
CurrentPriceStep

Current price step identifier

>
29
                    <PriceStepId
PriceStepId

Current price step identifier

>{Integer}</PriceStepId>
30
                    <Price
Price

Value of a price step

>{Decimal}</Price>
31
                    <PriceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

>{String}</PriceInterval>
32
                    <PriceStepLink
PriceStepLink

Current price step identifier

>{String}</PriceStepLink>
33
               </CurrentPriceStep>
34
               <Totals
Totals

Total amounts

>
35
                    <RecurringAmount
RecurringAmount

Accumulated value of recurring amounts

>{Decimal}</RecurringAmount>
36
                    <UsageAmount
UsageAmount

Accumulated value of usage amounts (usage unit defined in referenced RPR)

>{Decimal}</UsageAmount>
37
                    <DiscountAmount
DiscountAmount

Accumulated value of discount amounts

>{Decimal}</DiscountAmount>
38
                    <TotalAmount
TotalAmount

Aggregated value of all amounts

>{Decimal}</TotalAmount>
39
               </Totals>
40
               <SalesInvoiceIssueDate
SalesInvoiceIssueDate

Date of an invoice

>{Date}</SalesInvoiceIssueDate>
41
               <Quantity
Quantity

Quantity of invoiced item

>{Decimal}</Quantity>
42
               <PeriodStartDate
PeriodStartDate

Start date of an invoice period.

>{Date}</PeriodStartDate>
43
               <PeriodEndDate
PeriodEndDate

End date of an invoice period

>{Date}</PeriodEndDate>
44
               <BaseDate
BaseDate

A date from which invoices will start to be generated from

>{Date}</BaseDate>
45
               <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

>{Integer}</BaseDateAdvanceDays>
46
               <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

>{String}</InvoiceFrequency>
47
               <SalesInvoice
SalesInvoice

Sales invoice reference

>
48
                    <SalesInvoiceId
SalesInvoiceId

Sales invoice identifier

>{Integer}</SalesInvoiceId>
49
                    <SalesInvoiceLink
SalesInvoiceLink

Sales invoice reference

>{String}</SalesInvoiceLink>
50
               </SalesInvoice>
51
          </Row>
52
     </Rows>
53
     <Paging
Paging

Detailed paging information for this list.

>
54
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
57
          <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>
58
          <FirstPage
FirstPage

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

>{String}</FirstPage>
59
          <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>
60
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
61
          <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>
62
          <NextPage
NextPage

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

>{String}</NextPage>
63
          <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>
64
          <LastPage
LastPage

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

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

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

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

Status of recurring invoice period

Possible domain values can be found here

": "{Integer}",
6
                    "recurringInvoicePlanItem
RecurringInvoicePlanItem

Recurring invoice plan item reference

": {
7
                         "recurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

": {
8
                              "recurringInvoicePlanId
RecurringInvoicePlanId

Recurring invoice plan identifier

": "{Integer}"
9
                         },
10
                         "recurringInvoicePlanItemId
RecurringInvoicePlanItemId

Recurring invoice plan item identifier

": "{Integer}",
11
                         "title
Title

A short description of the recurring invoice plan

": "{String}",
12
                         "recurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Reference to the recurring invoice plan item.

": "{String}"
13
                    },
14
                    "customersReference
CustomersReference

Customers reference. Typically a person.

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

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

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

Customer reference

": {
17
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
21
                    },
22
                    "currency
Currency

Recurring invoice plan currency

": "{String}",
23
                    "product
Product

Product reference

": {
24
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
28
                    },
29
                    "currentPriceStep
CurrentPriceStep

Current price step identifier

": {
30
                         "priceStepId
PriceStepId

Current price step identifier

": "{Integer}",
31
                         "price
Price

Value of a price step

": "{Decimal}",
32
                         "priceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

": "{String}",
33
                         "priceStepLink
PriceStepLink

Current price step identifier

": "{String}"
34
                    },
35
                    "totals
Totals

Total amounts

": {
36
                         "recurringAmount
RecurringAmount

Accumulated value of recurring amounts

": "{Decimal}",
37
                         "usageAmount
UsageAmount

Accumulated value of usage amounts (usage unit defined in referenced RPR)

": "{Decimal}",
38
                         "discountAmount
DiscountAmount

Accumulated value of discount amounts

": "{Decimal}",
39
                         "totalAmount
TotalAmount

Aggregated value of all amounts

": "{Decimal}"
40
                    },
41
                    "salesInvoiceIssueDate
SalesInvoiceIssueDate

Date of an invoice

": "{Date}",
42
                    "quantity
Quantity

Quantity of invoiced item

": "{Decimal}",
43
                    "periodStartDate
PeriodStartDate

Start date of an invoice period.

": "{Date}",
44
                    "periodEndDate
PeriodEndDate

End date of an invoice period

": "{Date}",
45
                    "baseDate
BaseDate

A date from which invoices will start to be generated from

": "{Date}",
46
                    "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

": "{Integer}",
47
                    "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

": "{String}",
48
                    "salesInvoice
SalesInvoice

Sales invoice reference

": {
49
                         "salesInvoiceId
SalesInvoiceId

Sales invoice identifier

": "{Integer}",
50
                         "salesInvoiceLink
SalesInvoiceLink

Sales invoice reference

": "{String}"
51
                    }
52
               }
53
          ]
54
     }
55
}

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