credit_balance_movements

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

Overview

Name	credit_balance_movements
Type	Resource
Id	ovh.me.credit_balance_movements

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
movement_id	integer	Movement ID (wire: movementId)
order_id	integer	Order ID associated to this credit movement (wire: orderId)
balance_name	string	Balance name (wire: balanceName)
amount	object	Movement amount
creation_date	string (date-time)	Movement creation date (wire: creationDate)
destination_object	object	Object destination of this credit movement (wire: destinationObject)
expiration_date	string (date-time)	Movement expiration date (wire: expirationDate)
last_update	string (date-time)	Movement last update (wire: lastUpdate)
source_object	object	Object source of this credit movement (wire: sourceObject)
type	string	Movement type (BONUS, CANCEL, CREDIT_NOTE, EXPIRE, GIFT, MANUAL, ORDER, REFUND, UNPAID, USE, VOUCHER)

list

Missing description

Name	Datatype	Description
movement_id	integer	Movement ID (wire: movementId)
order_id	integer	Order ID associated to this credit movement (wire: orderId)
balance_name	string	Balance name (wire: balanceName)
amount	object	Movement amount
creation_date	string (date-time)	Movement creation date (wire: creationDate)
destination_object	object	Object destination of this credit movement (wire: destinationObject)
expiration_date	string (date-time)	Movement expiration date (wire: expirationDate)
last_update	string (date-time)	Movement last update (wire: lastUpdate)
source_object	object	Object source of this credit movement (wire: sourceObject)
type	string	Movement type (BONUS, CANCEL, CREDIT_NOTE, EXPIRE, GIFT, MANUAL, ORDER, REFUND, UNPAID, USE, VOUCHER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	balance_name, movement_id		Retrieve a specific movement for a credit balance
list	select	balance_name	x_pagination_mode	Retrieve movements for a specific balance

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"}})
balance_name	string	Balance name (wire: balanceName)
movement_id	integer	Movement ID (wire: movementId)
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

Retrieve a specific movement for a credit balance

SELECT
movement_id,
order_id,
balance_name,
amount,
creation_date,
destination_object,
expiration_date,
last_update,
source_object,
type
FROM ovh.me.credit_balance_movements
WHERE balance_name = '{{ balance_name }}' -- required
AND movement_id = '{{ movement_id }}' -- required
;

list

Retrieve movements for a specific balance

SELECT
movement_id,
order_id,
balance_name,
amount,
creation_date,
destination_object,
expiration_date,
last_update,
source_object,
type
FROM ovh.me.credit_balance_movements
WHERE balance_name = '{{ balance_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;