Sales APIs
Get recurring invoice plan item
| HTTP method | GET |
| URI | https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId} |
| 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 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 4395, version 42 |
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.
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
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.
RecurringInvoicePlanItemId
Recurring invoice plan item identifier
>{Integer}</RecurringInvoicePlanItemId>CreatedAt
Date of item creation
>{Date}</CreatedAt>Status
Status of the item: 9 = Done, 4 = Active, 3 = Future
Possible domain values can be found here
>{Integer}</Status>Quantity
Quantity of invoiced item
>{Integer}</Quantity>CustomersReferenceNumber
Customer item reference number. Comes originally from sales order item but updates independently.
>{String}</CustomersReferenceNumber>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>IsCalculating
Boolean indicating if there is currently a batch running which processes this specific recurring invoice item
>{Boolean}</IsCalculating>Description
Item description
>{String}</Description>Price
Value of a price step
>{Decimal}</Price>StartAt
Start date of the recurring invoice plan
>{Datetime}</StartAt>EndAt
Actual end date and time of the recurring invoice plan
>{Datetime}</EndAt>ExpectedEndAt
Expected end date of the recurring invoice plan. Used for the prognosis.
>{Datetime}</ExpectedEndAt>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>EstimatedAmount
Accumulated value of all amounts from recurring invoice periods
>{Decimal}</EstimatedAmount>AccruedAmount
Value of accrued amount from recurring invoice period
>{Decimal}</AccruedAmount>InvoicedAmount
Accumulated value of invoiced amounts from recurring invoice periods
>{Decimal}</InvoicedAmount>ForecastAmount
Accumulated value of forecasted amounts
>{Decimal}</ForecastAmount>RecurringPriceId
Recurring price indentifier
>{Integer}</RecurringPriceId>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PriceInterval
Interval of recurring price
Possible domain values can be found here
>{Integer}</PriceInterval>HasOneTimeFee
Boolean indicating if the recurring price associated with the item has a one-time fee.
>{Boolean}</HasOneTimeFee>HasUsageStep
Boolean indicating if the recurring price associated with the item has any usage steps.
>{Boolean}</HasUsageStep>RecurringPriceLink
Recurring price indentifier
>{String}</RecurringPriceLink>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>RecurringInvoicePlanItemId
Source item of recurring invoice plan. Used for tracking the source.
>{Integer}</RecurringInvoicePlanItemId>RecurringInvoicePlanId
Source identifier of recurring invoice plan. Used for tracking the source.
>{Integer}</RecurringInvoicePlanId>RecurringInvoicePlanLink
Recurring invoice plan reference
>{String}</RecurringInvoicePlanLink>RecurringInvoicePlanItemLink
Reference to the recurring invoice plan item.
>{String}</RecurringInvoicePlanItemLink>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>VATPercent
Value added tax percent
>{Decimal}</VATPercent>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
The department related to the item. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>Asset
The asset related to the item. One of the system/fixed account dimensions.
>AssetId
Asset identifier
>{Integer}</AssetId>AssetLink
Asset reference
>{String}</AssetLink>RecurringInvoicePlanItemId
Recurring invoice plan item identifier
": "{Integer}",CreatedAt
Date of item creation
": "{Date}",Status
Status of the item: 9 = Done, 4 = Active, 3 = Future
Possible domain values can be found here
": "{Integer}",Quantity
Quantity of invoiced item
": "{Integer}",CustomersReferenceNumber
Customer item reference number. Comes originally from sales order item but updates independently.
": "{String}",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}",IsCalculating
Boolean indicating if there is currently a batch running which processes this specific recurring invoice item
": "{Boolean}",Description
Item description
": "{String}",Price
Value of a price step
": "{Decimal}"StartAt
Start date of the recurring invoice plan
": "{Datetime}",EndAt
Actual end date and time of the recurring invoice plan
": "{Datetime}",ExpectedEndAt
Expected end date of the recurring invoice plan. Used for the prognosis.
": "{Datetime}"Currency
Three character code following the ISO 4217 standard
": "{String}",EstimatedAmount
Accumulated value of all amounts from recurring invoice periods
": "{Decimal}",AccruedAmount
Value of accrued amount from recurring invoice period
": "{Decimal}",InvoicedAmount
Accumulated value of invoiced amounts from recurring invoice periods
": "{Decimal}",ForecastAmount
Accumulated value of forecasted amounts
": "{Decimal}"RecurringPriceId
Recurring price indentifier
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",PriceInterval
Interval of recurring price
Possible domain values can be found here
": "{Integer}",HasOneTimeFee
Boolean indicating if the recurring price associated with the item has a one-time fee.
": "{Boolean}",HasUsageStep
Boolean indicating if the recurring price associated with the item has any usage steps.
": "{Boolean}",RecurringPriceLink
Recurring price indentifier
": "{String}"SalesOrderItemId
Sales order item identifier
": "{Integer}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"RecurringInvoicePlanItemId
Source item of recurring invoice plan. Used for tracking the source.
": "{Integer}",RecurringInvoicePlanId
Source identifier of recurring invoice plan. Used for tracking the source.
": "{Integer}",RecurringInvoicePlanLink
Recurring invoice plan reference
": "{String}"RecurringInvoicePlanItemLink
Reference to the recurring invoice plan item.
": "{String}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
": {VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",VATPercent
Value added tax percent
": "{Decimal}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
The department related to the item. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"Asset
The asset related to the item. One of the system/fixed account dimensions.
": {AssetId
Asset identifier
": "{Integer}",AssetLink
Asset reference
": "{String}"
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 |