| Excerpt |
|---|
This method returns information related with applied additive discounts (discounts that have been already taken into consideration by billing engine). Multiple applied additive discounts are returned by each call |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
| additive_discount_definition_identifier (semi-optional) | Additive Discount Definition identifier | The identifier of the additive discount definition related with the applied additive that should be returned as a result. The allowed additive discount definition identifier fields are the following:
| ||||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the applied additive discount that should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||||
| subscription_identifier (semi-optional) | Subscription identifier | The identifier of the subscription related with the applied additive discount that should be returned as a result. The allowed subscription identifier fields are the following:
| ||||||||
job_identifier (semi-optional) | Job identifier | The identifier of the job related with the applied additive discount that should be returned as a result. The allowed job identifier fields are the following:
| ||||||||
invoice_identifier (semi-optional) | Invoice identifier | The identifier of the job related with the applied additive discount that should be returned as a result. The allowed job identifier fields are the following:
| ||||||||
additive_discount_definition_classification (semi-optional) | String | The classification of the additive discount definition related with the applied additive that should be returned as a result. The supported classifications are SUBSCRIPTIONS and JOBS
| ||||||||
additive_discount_definition_type (semi-optional) | String | The type of the additive discount definition related with the applied additive that should be returned as a result. The supported classifications are AUTO_APPLIED and AD_HOC | ||||||||
from_date (optional) | Date | It determines the date that the applied additive discount becomes effective. If specified then only applied additive discounts which were effective on that date or after that date will be retrieved | ||||||||
to_date (optional) | Date | It determines the date that the applied additive discount becomes not effective. If specified then only applied additive discounts which were effective up to that date or before that date will be retrieved | ||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...