corrective_invoice_debts
Creates, updates, deletes, gets or lists a corrective_invoice_debts resource.
Overview​
| Name | corrective_invoice_debts |
| Type | Resource |
| Id | ovh.me.corrective_invoice_debts |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
debt_id | integer | (wire: debtId) |
order_id | integer | The order the debt relates to (wire: orderId) |
amount | object | Original amount of the debt |
date | string (date-time) | Date the debt was created on |
due_amount | object | Amount you still owe for that debt (wire: dueAmount) |
due_date | string (date-time) | If specified, the debt will not be recovered before that date (wire: dueDate) |
pending_amount | object | Amount currently being processed (wire: pendingAmount) |
status | string | Status of a debt (PAID, REFUNDED, TO_BE_PAID, UNMATURED, UNPAID, WRITE_OFF) |
todo_amount | object | Reserved amount awaiting payment (wire: todoAmount) |
unmatured_amount | object | Unmatured amount for deferred payment term (wire: unmaturedAmount) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | corrective_invoice_id | Get this object properties | |
pay | exec | correctiveInvoiceId | Create an order in order to pay this order's debt |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
correctiveInvoiceId | string | |
corrective_invoice_id | string | (wire: correctiveInvoiceId) |
SELECT examples​
- get
Get this object properties
SELECT
debt_id,
order_id,
amount,
date,
due_amount,
due_date,
pending_amount,
status,
todo_amount,
unmatured_amount
FROM ovh.me.corrective_invoice_debts
WHERE corrective_invoice_id = '{{ corrective_invoice_id }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- pay
Create an order in order to pay this order's debt
EXEC ovh.me.corrective_invoice_debts.pay
@correctiveInvoiceId='{{ correctiveInvoiceId }}' --required
;