refunds

Creates, updates, deletes, gets or lists a refunds resource.

Overview

Name	refunds
Type	Resource
Id	ovh.me.refunds

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	(wire: orderId)
original_bill_id	string	(wire: originalBillId)
refund_id	string	(wire: refundId)
date	string (date-time)
password	string
pdf_url	string	(wire: pdfUrl)
price_with_tax	object	Price with its currency and textual representation (wire: priceWithTax)
price_without_tax	object	Price with its currency and textual representation (wire: priceWithoutTax)
tax	object	Price with its currency and textual representation
url	string

list

Details about a Refund

Name	Datatype	Description
order_id	integer	(wire: orderId)
original_bill_id	string	(wire: originalBillId)
refund_id	string	(wire: refundId)
date	string (date-time)
password	string
pdf_url	string	(wire: pdfUrl)
price_with_tax	object	Price with its currency and textual representation (wire: priceWithTax)
price_without_tax	object	Price with its currency and textual representation (wire: priceWithoutTax)
tax	object	Price with its currency and textual representation
url	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	refund_id		Get this object properties
list	select		date.from, date.to, order_id, x_pagination_mode	List of all the refunds the logged account has
export	exec	archiveType		Exports a bundle of refunds

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"}})
refund_id	string	(wire: refundId)
date.from	string (date-time)	Filter the value of date property (>=)
date.to	string (date-time)	Filter the value of date property (<=)
order_id	integer	Filter the value of orderId property (=) (wire: orderId)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
order_id,
original_bill_id,
refund_id,
date,
password,
pdf_url,
price_with_tax,
price_without_tax,
tax,
url
FROM ovh.me.refunds
WHERE refund_id = '{{ refund_id }}' -- required
;

list

List of all the refunds the logged account has

SELECT
order_id,
original_bill_id,
refund_id,
date,
password,
pdf_url,
price_with_tax,
price_without_tax,
tax,
url
FROM ovh.me.refunds
WHERE date.from = '{{ date.from }}'
AND date.to = '{{ date.to }}'
AND order_id = '{{ order_id }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

export

Exports a bundle of refunds

EXEC ovh.me.refunds.export 
@@json=
'{
"archiveType": "{{ archiveType }}", 
"endDate": "{{ endDate }}", 
"ids": "{{ ids }}", 
"startDate": "{{ startDate }}"
}'
;