API

Sales APIs

GET sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/recurring-invoice-periods

List of recurring invoice periods

HTTP method GET
URI https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/recurring-invoice-periods
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {recurringInvoicePlanId} Recurring invoice plan identifier
Integer, minimum 100000
- URI parameter {itemId} Recurring invoice plan item identifier
Integer, minimum 1
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4402, 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.

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

Active() Named filter Active recurring invoice periods
ActiveAndRecent() Named filter Active and recent recurring invoice periods
Current() Named filter Current recuring invoice period
Forecast() Named filter Forecast recurring invoice periods
Invoiced() Named filter Invoiced recurring invoice periods
BaseDate Date Planned invoicing date (invoice period base date). Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DiscountAmount Decimal Accumulated value of discount amounts.
EndDate Date End date of an invoice period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpectedUsage Decimal Expected usage (usage unit defined in referenced RPR).
FeeAmount Decimal Accumulated value of fee amounts (sum of one-time fees of active RPR).
RecurringAmount Decimal Accumulated value of recurring amounts.
RecurringInvoicePeriodId Integer Recurring invoice period identifier.
RecurringPriceId Integer Recurring price indentifier.
SalesInvoiceId Integer Sales invoice identifier.
StartDate Date Start date of an invoice period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of recurring invoice period.
TotalAmount Decimal Aggregated value of all amounts.
UsageAmount Decimal Accumulated value of usage amounts (usage unit defined in referenced RPR).

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

BaseDate Date Planned invoicing date (invoice period base date)
CreatedAt Datetime Date and time of creation
DiscountAmount Decimal Accumulated value of discount amounts
EndDate Date End date of an invoice period
ExpectedUsage Decimal Expected usage (usage unit defined in referenced RPR)
FeeAmount Decimal Accumulated value of fee amounts (sum of one-time fees of active RPR)
RecurringAmount Decimal Accumulated value of recurring amounts
RecurringInvoicePeriodId Integer Recurring invoice period identifier
RecurringPriceId Integer Recurring price indentifier
SalesInvoiceId Integer Sales invoice identifier
StartDate Date Start date of an invoice period.
Status Integer Status of recurring invoice period
TotalAmount Decimal Aggregated value of all amounts
UsageAmount Decimal Accumulated value of usage amounts (usage unit defined in referenced RPR)

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
<RecurringInvoicePeriods>
2
     <RecurringInvoicePeriod>
3
          <RecurringInvoicePeriodId
RecurringInvoicePeriodId

Recurring invoice period identifier

>{Integer}</RecurringInvoicePeriodId>
4
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
          <Status
Status

Status of recurring invoice period

Possible domain values can be found here

>{Integer}</Status>
6
          <BaseDate
BaseDate

Planned invoicing date (invoice period base date)

>{Date}</BaseDate>
7
          <ExpectedUsage
ExpectedUsage

Expected usage (usage unit defined in referenced RPR)

>{Decimal}</ExpectedUsage>
8
          <Totals>
9
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
10
               <OneTimeFeeAmount
OneTimeFeeAmount

Accumulated value of fee amounts (sum of one-time fees of active RPR)

>{Decimal}</OneTimeFeeAmount>
11
               <RecurringAmount
RecurringAmount

Accumulated value of recurring amounts

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

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

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

Accumulated value of discount amounts

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

Aggregated value of all amounts

>{Decimal}</TotalAmount>
15
          </Totals>
16
          <SalesInvoice
SalesInvoice

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

>
17
               <SalesInvoiceId
SalesInvoiceId

Sales invoice identifier

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

>{Integer}</SalesInvoiceId>
18
               <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

>{Datetime}</CreatedAt>
19
               <IssueDate
IssueDate

Invoice date

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

>{Date}</IssueDate>
20
               <Status
Status

Status of the sales invoice

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

>{Integer}</Status>
21
               <SalesInvoiceLink
SalesInvoiceLink

Sales invoice reference

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

>{String}</SalesInvoiceLink>
22
          </SalesInvoice>
23
          <RecurringPrice>
24
               <RecurringPriceId
RecurringPriceId

Recurring price indentifier

>{Integer}</RecurringPriceId>
25
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
26
               <PriceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

>{Integer}</PriceInterval>
27
               <HasOneTimeFee
HasOneTimeFee

Boolean indicating if the recurring price has a one-time fee.

>{Boolean}</HasOneTimeFee>
28
               <HasUsageStep
HasUsageStep

Boolean indicating if the recurring price has any usage steps.

>{Boolean}</HasUsageStep>
29
               <RecurringPriceLink
RecurringPriceLink

Recurring price reference

>{String}</RecurringPriceLink>
30
          </RecurringPrice>
31
          <CurrentPriceStep
CurrentPriceStep

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.CurrentPriceStep in your request URI to get this field

>
32
               <Price
Price

Value of a price step

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.CurrentPriceStep in your request URI to get this field

>{Decimal}</Price>
33
          </CurrentPriceStep>
34
          <Period>
35
               <StartDate
StartDate

Start date of an invoice period.

>{Date}</StartDate>
36
               <EndDate
EndDate

End date of an invoice period

>{Date}</EndDate>
37
          </Period>
38
          <RecurringInvoicePeriodLink
RecurringInvoicePeriodLink

Recurring invoice period reference

>{String}</RecurringInvoicePeriodLink>
39
     </RecurringInvoicePeriod>
40
     <Paging
Paging

Detailed paging information for this list.

>
41
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
44
          <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>
45
          <FirstPage
FirstPage

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

>{String}</FirstPage>
46
          <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>
47
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
48
          <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>
49
          <NextPage
NextPage

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

>{String}</NextPage>
50
          <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>
51
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
53
     </Paging>
54
</RecurringInvoicePeriods>
1
{
2
     "recurringInvoicePeriods": [
3
          {
4
               "recurringInvoicePeriodId
RecurringInvoicePeriodId

Recurring invoice period identifier

": "{Integer}",
5
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
               "status
Status

Status of recurring invoice period

Possible domain values can be found here

": "{Integer}",
7
               "baseDate
BaseDate

Planned invoicing date (invoice period base date)

": "{Date}",
8
               "expectedUsage
ExpectedUsage

Expected usage (usage unit defined in referenced RPR)

": "{Decimal}",
9
               "totals": {
10
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
11
                    "oneTimeFeeAmount
OneTimeFeeAmount

Accumulated value of fee amounts (sum of one-time fees of active RPR)

": "{Decimal}",
12
                    "recurringAmount
RecurringAmount

Accumulated value of recurring amounts

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

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

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

Accumulated value of discount amounts

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

Aggregated value of all amounts

": "{Decimal}"
16
               },
17
               "salesInvoice
SalesInvoice

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

": {
18
                    "salesInvoiceId
SalesInvoiceId

Sales invoice identifier

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

": "{Integer}",
19
                    "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

": "{Datetime}",
20
                    "issueDate
IssueDate

Invoice date

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

": "{Date}",
21
                    "status
Status

Status of the sales invoice

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

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

Sales invoice reference

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.SalesInvoice in your request URI to get this field

": "{String}"
23
               },
24
               "recurringPrice": {
25
                    "recurringPriceId
RecurringPriceId

Recurring price indentifier

": "{Integer}",
26
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
27
                    "priceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

": "{Integer}",
28
                    "hasOneTimeFee
HasOneTimeFee

Boolean indicating if the recurring price has a one-time fee.

": "{Boolean}",
29
                    "hasUsageStep
HasUsageStep

Boolean indicating if the recurring price has any usage steps.

": "{Boolean}",
30
                    "recurringPriceLink
RecurringPriceLink

Recurring price reference

": "{String}"
31
               },
32
               "currentPriceStep
CurrentPriceStep

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.CurrentPriceStep in your request URI to get this field

": {
33
                    "price
Price

Value of a price step

This field is greyed out because it is an expandable field. You have to add $expand=RecurringInvoicePeriod.CurrentPriceStep in your request URI to get this field

": "{Decimal}"
34
               },
35
               "period": {
36
                    "startDate
StartDate

Start date of an invoice period.

": "{Date}",
37
                    "endDate
EndDate

End date of an invoice period

": "{Date}"
38
               },
39
               "recurringInvoicePeriodLink
RecurringInvoicePeriodLink

Recurring invoice period reference

": "{String}"
40
          }
41
     ],
42
     "paging
Paging

Detailed paging information for this list.

": {
43
          "pageSize
PageSize

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

": "{Integer}",
44
          "position
Position

Position of the first element in the list

": "{Integer}",
45
          "page
Page

Page index

": "{Integer}",
46
          "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}",
47
          "firstPage
FirstPage

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

": "{String}",
48
          "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}",
49
          "previousPage
PreviousPage

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

": "{String}",
50
          "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}",
51
          "nextPage
NextPage

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

": "{String}",
52
          "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}",
53
          "lastPage
LastPage

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

": "{String}",
54
          "size
Size

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

": "{Integer}"
55
     }
56
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects
Error 105970 HTTP 400 End date is required