| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | {"description":"The unique id of the charge to be recalculated.","verbs":["POST","GET"]} | |
| name | String | {"description":"New friendly name given to the charge to help identify it.","verbs":["POST","GET"]} | [optional] |
| description | String | {"description":"New description given to the charge.","verbs":["POST","GET"]} | [optional] |
| amount | Float | {"description":"(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)<br>New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).<br>This amount excludes tax.","verbs":["POST","GET"]} | [optional] |
| invoicing_type | String | {"default":"<span class=\"label label-default\">Aggregated</span>","description":"The strategy for how to raise invoices describing the charges produced by this charge recalculation.<br><span class=\"label label-default\">Immediate</span> — Generate straight-away an invoice containing these charges.<br><span class=\"label label-default\">Aggregated</span> — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.","verbs":["POST","GET"]} | [optional] |
| pricing_component_value | Integer | {"description":"(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)<br>The updated value consumed of the pricing component which this charge concerns.","verbs":["POST","GET"]} | [optional] |
| recalculation_behaviour | String | {"default":"RecalculateWithLatestPricing","verbs":["POST","GET"]} | |
| organization_id | String | {"default":"(Auto-populated using your authentication credentials) ID of the organization actioning this request.","description":"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.","verbs":["POST"]} | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.