Sales APIs
Creates a discount
| HTTP method | POST |
| URI | https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/recurring-invoice-periods/{recurringInvoicePeriodId}/discounts |
| 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 | 201 |
| API resource identifier | 4422, 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.
Reason
Required/mandatory field
Reason of a discount (i.e. service)
Applicable domain values can be found here
>{String}</Reason>Amount
Required/mandatory field
Discount amount
Minimum value: 0
>{Decimal}</Amount>Comment
Comment about a discount
This field is optional.
>{String}</Comment>Reason
Required/mandatory field
Reason of a discount (i.e. service)
Applicable domain values can be found here
": "{String}",Amount
Required/mandatory field
Discount amount
Minimum value: 0
": "{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. |
| $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] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
DiscountId
Discount identifier
>{Integer}</DiscountId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Reason
Reason of a discount (i.e. service)
Possible domain values can be found here
>{String}</Reason>Amount
Discount amount
>{Decimal}</Amount>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>Comment
Comment about a discount
>{String}</Comment>DiscountId
Discount identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Reason
Reason of a discount (i.e. service)
Possible domain values can be found here
": "{String}",Amount
Discount amount
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Comment
Comment about a discount
": "{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 100085 HTTP 404 | Sales invoice not found |
| Error 100001 HTTP 404 | Address not found |
| Error 105970 HTTP 400 | End date is required |