Sales APIs
Update recurring invoice plan item
| HTTP method | PUT |
| 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 | 4699, version 17 |
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.
RecurringInvoicePlanItem
This field is optional.
>Description
Item description
This field is optional.
>{String}</Description>CustomersReferenceNumber
Customer item reference number. Comes originally from sales order item but updates independently.
This field is optional.
>{String}</CustomersReferenceNumber>PriceChangeAgreement
Type of recurring price (FIXED, MANUAL, AUTO). Defines if and how the recurring price can be updated.
Applicable domain values can be found here
This field is optional.
>{Integer}</PriceChangeAgreement>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
This field is optional.
>VATCodeDefinition
This field is optional.
>VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
>{String}</VATCode>VATPercent
Value added tax percent
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</VATPercent>GeneralLedgerAccount
This field is optional.
>GeneralLedgerAccountId
General ledger account identifier
Minimum value: 1000
This field is optional.
>{Integer}</GeneralLedgerAccountId>Department
The department related to the item. One of the system/fixed account dimensions.
This field is optional.
>DepartmentId
Department identifier
Minimum value: 1
This field is optional.
>{Integer}</DepartmentId>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
This field is optional.
>FinanceProjectId
Finance project identifier
Minimum value: 1
This field is optional.
>{Integer}</FinanceProjectId>Asset
The asset related to the item. One of the system/fixed account dimensions.
This field is optional.
>AssetId
Asset identifier
Minimum value: 1
This field is optional.
>{Integer}</AssetId>RecurringInvoicePlanItem
This field is optional.
": {Description
Item description
This field is optional.
": "{String}",CustomersReferenceNumber
Customer item reference number. Comes originally from sales order item but updates independently.
This field is optional.
": "{String}",PriceChangeAgreement
Type of recurring price (FIXED, MANUAL, AUTO). Defines if and how the recurring price can be updated.
Applicable domain values can be found here
This field is optional.
": "{Integer}",Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
This field is optional.
": {VATCodeDefinition
This field is optional.
": {VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
": "{String}",VATPercent
Value added tax percent
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}"GeneralLedgerAccount
This field is optional.
": {GeneralLedgerAccountId
General ledger account identifier
Minimum value: 1000
This field is optional.
": "{Integer}"Department
The department related to the item. One of the system/fixed account dimensions.
This field is optional.
": {DepartmentId
Department identifier
Minimum value: 1
This field is optional.
": "{Integer}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
This field is optional.
": {FinanceProjectId
Finance project identifier
Minimum value: 1
This field is optional.
": "{Integer}"Asset
The asset related to the item. One of the system/fixed account dimensions.
This field is optional.
": {AssetId
Asset identifier
Minimum value: 1
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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.
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 |