API

Sales APIs

GET sales/recurring-invoice-plan-items

List of all recurring invoice plan items

HTTP method GET
URI https://api.rambase.net/sales/recurring-invoice-plan-items
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 2764, version 20

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

ActiveAndFuture() Named filter Active and future items
CreatedAt Datetime Date of item creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
Description String Item description.
PriceChangeAgreement Integer Type of recurring price (FIXED, MANUAL, AUTO). Defines if and how the recurring price can be updated.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Integer Quantity of invoiced item.
RecurringInvoicePlanId Integer Source identifier of recurring invoice plan. Used for tracking the source.
RecurringInvoicePlanItemId Integer Recurring invoice plan item identifier.
SalesOrderId Integer Sales order identifier.
Status Integer Status of the item: 9 = Done, 4 = Active, 3 = Future.

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

CreatedAt Datetime Date of item creation
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
Description String Item description
PriceChangeAgreement Integer Type of recurring price (FIXED, MANUAL, AUTO). Defines if and how the recurring price can be updated.
ProductId Integer Product identifier
ProductName String Name of the product
Quantity Integer Quantity of invoiced item
RecurringInvoicePlanId Integer Source identifier of recurring invoice plan. Used for tracking the source.
RecurringInvoicePlanItemId Integer Recurring invoice plan item identifier
SalesOrderId Integer Sales order identifier
Status Integer Status of the item: 9 = Done, 4 = Active, 3 = Future

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
<RecurringInvoicePlanItems>
2
     <RecurringInvoicePlanItem>
3
          <RecurringInvoicePlanItemId
RecurringInvoicePlanItemId

Recurring invoice plan item identifier

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

Date of item creation

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

Status of the item: 9 = Done, 4 = Active, 3 = Future

Possible domain values can be found here

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

Quantity of invoiced item

>{Integer}</Quantity>
7
          <CustomersReferenceNumber
CustomersReferenceNumber

Customer item reference number. Comes originally from sales order item but updates independently.

>{String}</CustomersReferenceNumber>
8
          <PriceChangeAgreement
PriceChangeAgreement

Type of recurring price (FIXED, MANUAL, AUTO). Defines if and how the recurring price can be updated.

Possible domain values can be found here

>{Integer}</PriceChangeAgreement>
9
          <Description
Description

Item description

>{String}</Description>
10
          <Source>
11
               <RecurringInvoicePlanItemId
RecurringInvoicePlanItemId

Source item of recurring invoice plan. Used for tracking the source.

>{Integer}</RecurringInvoicePlanItemId>
12
               <RecurringInvoicePlan>
13
                    <RecurringInvoicePlanId
RecurringInvoicePlanId

Source identifier of recurring invoice plan. Used for tracking the source.

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

Recurring invoice plan reference

>{String}</RecurringInvoicePlanLink>
15
               </RecurringInvoicePlan>
16
               <RecurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Reference to the recurring invoice plan item.

>{String}</RecurringInvoicePlanItemLink>
17
          </Source>
18
          <SalesOrderItem>
19
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
20
               <Product>
21
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>{String}</ProductLink>
24
               </Product>
25
               <SalesOrder>
26
                    <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
28
               </SalesOrder>
29
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
30
          </SalesOrderItem>
31
          <Period>
32
               <StartAt
StartAt

Start date of the recurring invoice plan

>{Datetime}</StartAt>
33
               <EndAt
EndAt

Actual end date and time of the recurring invoice plan

>{Datetime}</EndAt>
34
               <ExpectedEndAt
ExpectedEndAt

Expected end date of the recurring invoice plan. Used for the prognosis.

>{Datetime}</ExpectedEndAt>
35
          </Period>
36
          <RecurringPrice>
37
               <RecurringPriceId
RecurringPriceId

Recurring price indentifier

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

Three character code following the ISO 4217 standard

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

Interval of recurring price

Possible domain values can be found here

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

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

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

Boolean indicating if the recurring price associated with the item has any usage steps.

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

Recurring price indentifier

>{String}</RecurringPriceLink>
43
          </RecurringPrice>
44
          <CurrentPriceStep
CurrentPriceStep

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

>
45
               <Price
Price

Value of a price step

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

>{Decimal}</Price>
46
          </CurrentPriceStep>
47
          <RecurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Reference to the recurring invoice plan item.

>{String}</RecurringInvoicePlanItemLink>
48
     </RecurringInvoicePlanItem>
49
     <Paging
Paging

Detailed paging information for this list.

>
50
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
53
          <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>
54
          <FirstPage
FirstPage

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

>{String}</FirstPage>
55
          <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>
56
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
57
          <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>
58
          <NextPage
NextPage

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

>{String}</NextPage>
59
          <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>
60
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
62
     </Paging>
63
</RecurringInvoicePlanItems>
1
{
2
     "recurringInvoicePlanItems": [
3
          {
4
               "recurringInvoicePlanItemId
RecurringInvoicePlanItemId

Recurring invoice plan item identifier

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

Date of item creation

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

Status of the item: 9 = Done, 4 = Active, 3 = Future

Possible domain values can be found here

": "{Integer}",
7
               "quantity
Quantity

Quantity of invoiced item

": "{Integer}",
8
               "customersReferenceNumber
CustomersReferenceNumber

Customer item reference number. Comes originally from sales order item but updates independently.

": "{String}",
9
               "priceChangeAgreement
PriceChangeAgreement

Type of recurring price (FIXED, MANUAL, AUTO). Defines if and how the recurring price can be updated.

Possible domain values can be found here

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

Item description

": "{String}",
11
               "source": {
12
                    "recurringInvoicePlanItemId
RecurringInvoicePlanItemId

Source item of recurring invoice plan. Used for tracking the source.

": "{Integer}",
13
                    "recurringInvoicePlan": {
14
                         "recurringInvoicePlanId
RecurringInvoicePlanId

Source identifier of recurring invoice plan. Used for tracking the source.

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

Recurring invoice plan reference

": "{String}"
16
                    },
17
                    "recurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Reference to the recurring invoice plan item.

": "{String}"
18
               },
19
               "salesOrderItem": {
20
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
21
                    "product": {
22
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

": "{String}"
25
                    },
26
                    "salesOrder": {
27
                         "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
29
                    },
30
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
31
               },
32
               "period": {
33
                    "startAt
StartAt

Start date of the recurring invoice plan

": "{Datetime}",
34
                    "endAt
EndAt

Actual end date and time of the recurring invoice plan

": "{Datetime}",
35
                    "expectedEndAt
ExpectedEndAt

Expected end date of the recurring invoice plan. Used for the prognosis.

": "{Datetime}"
36
               },
37
               "recurringPrice": {
38
                    "recurringPriceId
RecurringPriceId

Recurring price indentifier

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

Three character code following the ISO 4217 standard

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

Interval of recurring price

Possible domain values can be found here

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

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

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

Boolean indicating if the recurring price associated with the item has any usage steps.

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

Recurring price indentifier

": "{String}"
44
               },
45
               "currentPriceStep
CurrentPriceStep

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

": {
46
                    "price
Price

Value of a price step

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

": "{Decimal}"
47
               },
48
               "recurringInvoicePlanItemLink
RecurringInvoicePlanItemLink

Reference to the recurring invoice plan item.

": "{String}"
49
          }
50
     ],
51
     "paging
Paging

Detailed paging information for this list.

": {
52
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
64
     }
65
}

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 105932 HTTP 400 From quantity should be greater than 0
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required