# mba-cli invoice

> Read invoices

Read invoices

CLI version: `0.3.2`

## Commands

### mba-cli invoice account-invoices

List invoices for one billing account

List invoices for a billing account

Retrieves invoices for one billing account with pagination, sorting, search, invoice type/state, collection method, currency, origin, related booking/subscription IDs, invoice ID CSV filters, and created-date ranges. For OpenAPI tool calls, pass the account id in path and all list controls in query.

List invoices for one billing account

Flags:

- `--account-id` (string): Billing account id
- `--all` (bool, default `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, default `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, default `1`): Query parameter page (from the API spec)
- `--paginate` (bool, default `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)

API endpoints:

- GET /billing/accounts/{id}/invoices — https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllAccountInvoices

### mba-cli invoice get

Get one invoice by id

Get single invoice resource

Get a single invoice resource

Get one invoice by id

Flags:

- `--id` (string): Invoice id

API endpoints:

- GET /billing/invoices/{invoiceId} — https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleInvoice

### mba-cli invoice get-by-number

Get one invoice by invoice number

Get single account invoice by number resource

Get a single account invoice by number resource

Get one invoice by invoice number

Flags:

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

API endpoints:

- GET /billing/invoices/number/{invoiceNumber} — https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleAccountInvoiceByNumber

### mba-cli invoice ls

List invoices across billing accounts

List invoices across billing accounts

Retrieves invoices across billing accounts with pagination, sorting, search, invoice type/state, collection method, currency, origin, related booking/subscription IDs, invoice ID CSV filters, and created-date ranges. Studio Copilot should pass these controls in mpptenant_call_api.query when paging or narrowing invoice results.

List invoices across billing accounts

Flags:

- `--all` (bool, default `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, default `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, default `1`): Query parameter page (from the API spec)
- `--paginate` (bool, default `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)

API endpoints:

- GET /billing/invoices — https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllInvoices

---

[Rendered page](https://mybusinessapp.co.za/developers/cli/reference/invoice)

© MyBusinessApp (Pty) Ltd. Proprietary documentation — do not republish.