Sales APIs
Update recurring invoice plan
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {recurringInvoicePlanId} |
Recurring invoice plan identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 4354, version 28 |
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.
RecurringInvoicePlan
This field is optional.
>Title
A short description of the recurring invoice plan
This field is optional.
>{String}</Title>Description
A more detailed description of the recurring invoice plan
This field is optional.
>{String}</Description>IsAutomaticallyIssued
"True" if invoices in this recurring invoice plan should be release automatically
This field is optional.
>{Boolean}</IsAutomaticallyIssued>BaseDate
A date from which invoices will start to be generated from
This field is optional.
>{Date}</BaseDate>InvoiceFrequency
Sets frequency at which invoice can be issued.
Applicable domain values can be found here
Minimum value: 0
This field is optional.
>{Integer}</InvoiceFrequency>CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
This field is optional.
>{Boolean}</CreateAccountAdjustmentPlan>CustomersReference
Customers reference. Typically a person.
This field is optional.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
>{String}</CustomersReferenceNumber>AdvanceInvoicing
This field is optional.
>BaseDateAdvanceDays
Number of days to advance invoicing from base date
Minimum value: 0
Maximum value: 30
This field is optional.
>{Integer}</BaseDateAdvanceDays>Responsible
PID reference to the owner of the recurring invoice plan
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Payment
This field is optional.
>PaymentTerms
Specifies how much time the buyer has to make payment
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>VATDetails
This field is optional.
>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
>{String}</VATHandling>RecurringInvoicePlan
This field is optional.
": {Title
A short description of the recurring invoice plan
This field is optional.
": "{String}",Description
A more detailed description of the recurring invoice plan
This field is optional.
": "{String}",IsAutomaticallyIssued
"True" if invoices in this recurring invoice plan should be release automatically
This field is optional.
": "{Boolean}",BaseDate
A date from which invoices will start to be generated from
This field is optional.
": "{Date}",InvoiceFrequency
Sets frequency at which invoice can be issued.
Applicable domain values can be found here
Minimum value: 0
This field is optional.
": "{Integer}",CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
This field is optional.
": "{Boolean}",CustomersReference
Customers reference. Typically a person.
This field is optional.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
": "{String}",AdvanceInvoicing
This field is optional.
": {BaseDateAdvanceDays
Number of days to advance invoicing from base date
Minimum value: 0
Maximum value: 30
This field is optional.
": "{Integer}"Responsible
PID reference to the owner of the recurring invoice plan
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Specifies how much time the buyer has to make payment
Applicable domain values can be found here
This field is optional.
": "{String}"VATDetails
This field is optional.
": {VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
": "{String}"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 102738 HTTP 404 | Price list not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |
| Error 106531 HTTP 400 | Base date of the recurring invoice plan which is already activated cannot be modified |
| Error 106086 HTTP 400 | Base date of recurring invoice plan is required |