mba-cli invoice

4 commands

Read invoices

Synopsis#

bash

mba-cli invoice <command> [flags]

Available commands#

mba-cli invoice account-invoicesList invoices for one billing account

List invoices for a billing account Returns the invoices for one billing account (`id` in the path), scoped to the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve a billing account`, `List invoices`. List invoices for one billing account

--account-id	string	Billing account id
--all	bool = false	Return all rows (paginate=false)
--booking-ids	string	Query parameter bookingIds (from the API spec)
--collection-method	string	Query parameter collectionMethod (from the API spec)
--currency	string	Query parameter currency (from the API spec)
--from-date	string	Query parameter fromDate (from the API spec)
--has-subscription	bool	Query parameter hasSubscription (from the API spec)
--ids	string	Query parameter ids (from the API spec)
--limit	int = 20	Query parameter limit (from the API spec)
--order	string	Query parameter order (from the API spec)
--origin	string	Query parameter origin (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = true	Query parameter paginate (from the API spec)
--search	string	Query parameter search (from the API spec)
--sort	string	Query parameter sort (from the API spec)
--state	string	Query parameter state (from the API spec)
--subscription-ids	string	Query parameter subscriptionIds (from the API spec)
--to-date	string	Query parameter toDate (from the API spec)
--type	string	Query parameter type (from the API spec)

GET/billing/accounts/{id}/invoices

mba-cli invoice getGet one invoice by id

Retrieve an invoice by id Returns the invoice with the given `invoiceId` for the tenant identified by the API key. Related: `List invoices`. Get one invoice by id

--id

string

Invoice id

GET/billing/invoices/{invoiceId}

mba-cli invoice get-by-numberGet one invoice by invoice number

Retrieve an invoice by number Returns the invoice with the given `invoiceNumber`. Invoice numbers are unique per tenant. Related: `Retrieve an invoice by id`, `List invoices`. Get one invoice by invoice number

--number

string

Invoice number with prefix (e.g. INVCS-1843)

GET/billing/invoices/number/{invoiceNumber}

mba-cli invoice lsList invoices across billing accounts

List invoices Returns the invoices across the tenant's billing accounts. Paginated: use `page`/`limit` or `paginate=false`. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an invoice by id`, `Retrieve an invoice by number`. List invoices across billing accounts

--all	bool = false	Return all rows (paginate=false)
--booking-ids	string	Query parameter bookingIds (from the API spec)
--collection-method	string	Query parameter collectionMethod (from the API spec)
--currency	string	Query parameter currency (from the API spec)
--from-date	string	Query parameter fromDate (from the API spec)
--has-subscription	bool	Query parameter hasSubscription (from the API spec)
--ids	string	Query parameter ids (from the API spec)
--limit	int = 20	Query parameter limit (from the API spec)
--order	string	Query parameter order (from the API spec)
--origin	string	Query parameter origin (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = true	Query parameter paginate (from the API spec)
--search	string	Query parameter search (from the API spec)
--sort	string	Query parameter sort (from the API spec)
--state	string	Query parameter state (from the API spec)
--subscription-ids	string	Query parameter subscriptionIds (from the API spec)
--to-date	string	Query parameter toDate (from the API spec)
--type	string	Query parameter type (from the API spec)

GET/billing/invoices

Was this page helpful?