Sales APIs
Recurring invoice period for provided indentifier
| HTTP method | GET |
| URI | https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/recurring-invoice-periods/{recurringInvoicePeriodId} |
| 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 |
| - URI parameter {recurringInvoicePeriodId} |
Recurring invoice period identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4408, version 9 |
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. |
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.
RecurringInvoicePeriodId
Recurring invoice period identifier
>{Integer}</RecurringInvoicePeriodId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Status
Status of recurring invoice period
Possible domain values can be found here
>{Integer}</Status>BaseDate
Planned invoicing date (invoice period base date)
>{Date}</BaseDate>ExpectedUsage
Expected usage (usage unit defined in referenced RPR)
>{Decimal}</ExpectedUsage>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>OneTimeFeeAmount
Accumulated value of fee amounts (sum of one-time fees of active RPR)
>{Decimal}</OneTimeFeeAmount>RecurringAmount
Accumulated value of recurring amounts
>{Decimal}</RecurringAmount>UsageAmount
Accumulated value of usage amounts (usage unit defined in referenced RPR)
>{Decimal}</UsageAmount>DiscountAmount
Accumulated value of discount amounts
>{Decimal}</DiscountAmount>TotalAmount
Aggregated value of all amounts
>{Decimal}</TotalAmount>SalesInvoiceId
Sales invoice identifier
>{Integer}</SalesInvoiceId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>IssueDate
Invoice date
>{Date}</IssueDate>SalesInvoiceLink
Sales invoice reference
>{String}</SalesInvoiceLink>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 has a one-time fee.
>{Boolean}</HasOneTimeFee>HasUsageStep
Boolean indicating if the recurring price has any usage steps.
>{Boolean}</HasUsageStep>RecurringPriceLink
Recurring price reference
>{String}</RecurringPriceLink>Price
Value of a price step
>{Decimal}</Price>StartDate
Start date of an invoice period.
>{Date}</StartDate>EndDate
End date of an invoice period
>{Date}</EndDate>RecurringInvoicePeriodId
Recurring invoice period identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of recurring invoice period
Possible domain values can be found here
": "{Integer}",BaseDate
Planned invoicing date (invoice period base date)
": "{Date}",ExpectedUsage
Expected usage (usage unit defined in referenced RPR)
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",OneTimeFeeAmount
Accumulated value of fee amounts (sum of one-time fees of active RPR)
": "{Decimal}",RecurringAmount
Accumulated value of recurring amounts
": "{Decimal}",UsageAmount
Accumulated value of usage amounts (usage unit defined in referenced RPR)
": "{Decimal}",DiscountAmount
Accumulated value of discount amounts
": "{Decimal}",TotalAmount
Aggregated value of all amounts
": "{Decimal}"SalesInvoiceId
Sales invoice identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",IssueDate
Invoice date
": "{Date}",Status
Status of the sales invoice
Possible domain values can be found here
": "{Integer}",SalesInvoiceLink
Sales invoice reference
": "{String}"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 has a one-time fee.
": "{Boolean}",HasUsageStep
Boolean indicating if the recurring price has any usage steps.
": "{Boolean}",RecurringPriceLink
Recurring price reference
": "{String}"Price
Value of a price step
": "{Decimal}"StartDate
Start date of an invoice period.
": "{Date}",EndDate
End date of an invoice period
": "{Date}"
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 |