deposit_paid_bills

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

Overview

Name	deposit_paid_bills
Type	Resource
Id	ovh.me.deposit_paid_bills

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
bill_id	string	(wire: billId)
e_invoicing_id	string	(wire: eInvoicingId)
order_id	integer	(wire: orderId)
category	string	Types of plans (autorenew, earlyrenewal, purchase, purchase-cloud, purchase-servers, purchase-telecom, purchase-web)
date	string (date-time)
e_invoicing_status	string	List of available eInvoicing Status types (accepted, error, ignored, invalid, new, ok, processing, readyToSubmit, rejected, submitted) (wire: eInvoicingStatus)
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 Bill

Name	Datatype	Description
bill_id	string	(wire: billId)
e_invoicing_id	string	(wire: eInvoicingId)
order_id	integer	(wire: orderId)
category	string	Types of plans (autorenew, earlyrenewal, purchase, purchase-cloud, purchase-servers, purchase-telecom, purchase-web)
date	string (date-time)
e_invoicing_status	string	List of available eInvoicing Status types (accepted, error, ignored, invalid, new, ok, processing, readyToSubmit, rejected, submitted) (wire: eInvoicingStatus)
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	bill_id, deposit_id		Get this object properties
list	select	deposit_id	x_pagination_mode	Get invoices paid by this deposit

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"}})
bill_id	string	(wire: billId)
deposit_id	string	(wire: depositId)
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
bill_id,
e_invoicing_id,
order_id,
category,
date,
e_invoicing_status,
password,
pdf_url,
price_with_tax,
price_without_tax,
tax,
url
FROM ovh.me.deposit_paid_bills
WHERE bill_id = '{{ bill_id }}' -- required
AND deposit_id = '{{ deposit_id }}' -- required
;

list

Get invoices paid by this deposit

SELECT
bill_id,
e_invoicing_id,
order_id,
category,
date,
e_invoicing_status,
password,
pdf_url,
price_with_tax,
price_without_tax,
tax,
url
FROM ovh.me.deposit_paid_bills
WHERE deposit_id = '{{ deposit_id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;