ovh_account_movements

Creates, updates, deletes, gets or lists an ovh_account_movements resource.

Overview

Name	ovh_account_movements
Type	Resource
Id	ovh.me.ovh_account_movements

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
movement_id	integer	(wire: movementId)
amount	object	Price with its currency and textual representation
balance	object	Price with its currency and textual representation
date	string (date-time)
description	string
operation	string	Operations an OVH account movement can represent (cancel-credit, cancel-debit, cancel-pre-debit, credit, debit, pre-credit, pre-debit)
order	integer
previous_balance	object	Price with its currency and textual representation (wire: previousBalance)
retrievable_amount	object	Price with its currency and textual representation (wire: retrievableAmount)

list

Details about an OVH account

Name	Datatype	Description
movement_id	integer	(wire: movementId)
amount	object	Price with its currency and textual representation
balance	object	Price with its currency and textual representation
date	string (date-time)
description	string
operation	string	Operations an OVH account movement can represent (cancel-credit, cancel-debit, cancel-pre-debit, credit, debit, pre-credit, pre-debit)
order	integer
previous_balance	object	Price with its currency and textual representation (wire: previousBalance)
retrievable_amount	object	Price with its currency and textual representation (wire: retrievableAmount)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	movement_id, ovh_account_id		Get this object properties
list	select	ovh_account_id	date.from, date.to, x_pagination_mode	Details about an entry of the OVH account
request_refund	exec	movementId, ovhAccountId, amount		request a refund of this credit note to your original payment method

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"}})
movementId	integer
movement_id	integer	(wire: movementId)
ovhAccountId	string
ovh_account_id	string	(wire: ovhAccountId)
date.from	string (date-time)	Filter the value of date property (>=)
date.to	string (date-time)	Filter the value of date property (<=)
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
movement_id,
amount,
balance,
date,
description,
operation,
order,
previous_balance,
retrievable_amount
FROM ovh.me.ovh_account_movements
WHERE movement_id = '{{ movement_id }}' -- required
AND ovh_account_id = '{{ ovh_account_id }}' -- required
;

list

Details about an entry of the OVH account

SELECT
movement_id,
amount,
balance,
date,
description,
operation,
order,
previous_balance,
retrievable_amount
FROM ovh.me.ovh_account_movements
WHERE ovh_account_id = '{{ ovh_account_id }}' -- required
AND date.from = '{{ date.from }}'
AND date.to = '{{ date.to }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

request_refund

request a refund of this credit note to your original payment method

EXEC ovh.me.ovh_account_movements.request_refund 
@movementId='{{ movementId }}' --required, 
@ovhAccountId='{{ ovhAccountId }}' --required 
@@json=
'{
"amount": {{ amount }}
}'
;