Sales APIs
Update provided discount
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/recurring-invoice-periods/{recurringInvoicePeriodId}/discounts/{discountId} |
| 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 |
| - URI parameter {discountId} |
Discount identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 4423, version 3 |
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.
Discount
This field is optional.
>Reason
Reason of a discount (i.e. service)
Applicable domain values can be found here
This field is optional.
>{String}</Reason>Amount
Discount amount
Minimum value: 0
This field is optional.
>{Decimal}</Amount>Comment
Comment about a discount
This field is optional.
>{String}</Comment>Discount
This field is optional.
": {Reason
Reason of a discount (i.e. service)
Applicable domain values can be found here
This field is optional.
": "{String}",Amount
Discount amount
Minimum value: 0
This field is optional.
": "{Decimal}",Comment
Comment about a discount
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. |
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 100085 HTTP 404 | Sales invoice not found |
| Error 100001 HTTP 404 | Address not found |
| Error 105970 HTTP 400 | End date is required |