Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,18 @@ Illustrative only: replace uppercase tokens; provide your own request.json for b
### Options

```
--bill-month string billMonth (query); Optional bill month filter.; pattern: "^\\d{4}-\\d{2}$"; illustrative example: "Mr. Corine Metz"
--cost-metric string costMetric (query); Optional cost metric filter.; illustrative example: "Ut quae doloremque."
--customer-billing-plan string customerBillingPlan (query); Optional billing plan filter.; illustrative example: "Iusto qui sequi esse voluptatem."
--customer-name string customerName (query); Optional customer name filter.; illustrative example: "Et facere assumenda voluptatem voluptatem illum."
--bill-month string billMonth (query); Optional bill month filter.; pattern: "^\\d{4}-\\d{2}$"; illustrative example: "Brenda Senger I"
--cost-metric string costMetric (query); Optional cost metric filter.; illustrative example: "Ullam et praesentium est."
--customer-billing-plan string customerBillingPlan (query); Optional billing plan filter.; illustrative example: "Voluptatum numquam dolores."
--customer-name string customerName (query); Optional customer name filter.; illustrative example: "Sit amet nesciunt ut sint nulla."
--export-type string exportType (query); Optional export type filter.; enum: ["pdf","csv"]; illustrative example: "csv"
--filter string filter (query); OData-style expression evaluated against each returned resource. Attribute names are case-sensitive and operators are case-insensitive. String eq, ne, and in comparisons are case-sensitive; co performs case-insensitive substring matching. Date values use YYYY-MM-DD; date-time values use ISO-8601 and are normalized to UTC; billMonth uses YYYY-MM. Missing fiel... (see cli schema); illustrative example: "deliveryStatus eq 'success' and billMonth eq '2026-09'"
-h, --help help for list
--limit int limit (query); Page size (default 10, max 200).; minimum: 1; maximum: 200; API default: 10; illustrative example: 165
--limit int limit (query); Page size (default 10, max 200).; minimum: 1; maximum: 200; API default: 10; illustrative example: 125
--no-paginate return only the first page (do not follow nextPage)
--order-by string orderBy (query); Optional orderBy query allows to specify an expression for determining what values are used to order the entities. Multiple expressions can be specified using comma separated values.; illustrative example: "updatedAt desc"
--schedule-id string scheduleId (path, required); Identifier of the invoice schedule.; required by API; illustrative example: "sch_1"
--skip-token string resume pagination from this token; An opaque token to be provided when requesting a subsequent page after receiving a partial response. Partial responses will include a "nextPage" attribute in their response body, which contains the URL of the next page including the appropriate skipToken.
--status string status (query); Optional generation status filter.; illustrative example: "Veniam harum corrupti nemo."
--status string status (query); Optional generation status filter.; illustrative example: "Voluptatem tempora distinctio."
```

### Options inherited from parent commands
Expand Down
5 changes: 2 additions & 3 deletions docs/cli/flexera-cli_finops-billing_invoice-schedules_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,11 @@ Illustrative only: replace uppercase tokens; provide your own request.json for b

```
--customer-id int customerId (query); Optional filter: only schedules covering this customer.; illustrative example: 53125
--filter string filter (query); OData-style expression evaluated against each returned resource. Attribute names are case-sensitive and operators are case-insensitive. String eq, ne, and in comparisons are case-sensitive; co performs case-insensitive substring matching. Date values use YYYY-MM-DD; date-time values use ISO-8601 and are normalized to UTC; billMonth uses YYYY-MM. Missing fiel... (see cli schema); illustrative example: "status eq 'active' and customerId eq 53125"
-h, --help help for list
--limit int limit (query); Page size (default 50, max 200); minimum: 1; maximum: 200; API default: 50; illustrative example: 7
--limit int limit (query); Page size (default 50, max 200); minimum: 1; maximum: 200; API default: 50; illustrative example: 162
--no-paginate return only the first page (do not follow nextPage)
--order-by string orderBy (query); Optional orderBy query allows to specify an expression for determining what values are used to order the entities. Multiple expressions can be specified using comma separated values.; illustrative example: "updatedAt desc"
--schedule-name string scheduleName (query); Optional exact-match filter on schedule name.; illustrative example: "Ut sint."
--schedule-name string scheduleName (query); Optional exact-match filter on schedule name.; illustrative example: "Eos voluptatem qui cupiditate."
--skip-token string resume pagination from this token; An opaque token to be provided when requesting a subsequent page after receiving a partial response. Partial responses will include a "nextPage" attribute in their response body, which contains the URL of the next page including the appropriate skipToken.
--status string status (query); Optional status filter.; enum: ["active","inactive"]; illustrative example: "active"
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Validated illustrative body, when available (review before use):
--dimensions strings dimensions (body); Optional grouping dimensions.; maxItems: 10; CLI: comma-separated values or repeated flag; illustrative example: ["service","account","region"]
--display-logo-within-pdf displayLogoWithinPdf (body); required by API; Whether the logo is rendered within PDF exports.; illustrative example: true
--dry-run print the planned operation as JSON and exit without calling the API
--export-layout string exportLayout (body); PDF layout format. Exact lowercase flatten or nested; omitted PDF exports default to flatten. Must be omitted for CSV exports.; enum: ["flatten","nested"]; illustrative example: "flatten"
--export-type string exportType (body); required by API; Invoice export type.; enum: ["pdf","csv"]; illustrative example: "pdf"
--free-text string freeText (body); Optional free-text company/address block.; illustrative example: "Aut accusamus."
-h, --help help for create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ Validated illustrative body, when available (review before use):
--dimensions strings dimensions (body); Updated grouping dimensions.; maxItems: 10; CLI: comma-separated values or repeated flag; illustrative example: ["Temporibus nihil minima non asperiores quisquam.","Qui animi temporibus non excepturi.","Quo praesentium ea vitae molestias dolores et."]
--display-logo-within-pdf displayLogoWithinPdf (body); Updated PDF logo display flag.; illustrative example: true
--dry-run print the planned operation as JSON and exit without calling the API
--export-layout string exportLayout (body); Updated PDF layout format. Exact lowercase flatten or nested; omitted PDF exports default to flatten. Must be omitted for CSV exports.; enum: ["flatten","nested"]; illustrative example: "nested"
--export-type string exportType (body); Updated export type.; enum: ["pdf","csv"]; illustrative example: "pdf"
--free-text string freeText (body); Updated free-text company/address block.; illustrative example: "Ut libero animi porro illo."
-h, --help help for update
--id string id (path, required); Invoice template identifier; required by API; illustrative example: "tmpl_9001"
-i, --interactive edit inputs in a terminal form, review a plan and approve with typed yes
--logo string logo (body); Updated logo payload.; illustrative example: "Pariatur illum quibusdam quis."
--logo string logo (body); Updated logo payload.; illustrative example: "Illum quibusdam quis."
--period-type string periodType (body); Updated period type.; enum: ["chargePeriod","billPeriod","billingPeriod"]; illustrative example: "billPeriod"
--template-name string templateName (body); Updated template name.; maxLength: 255; illustrative example: "561"
--yes confirm the operation (required for destructive ops)
Expand Down
25 changes: 13 additions & 12 deletions docs/cli/flexera-cli_finops-billing_invoices_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The invoice configuration can be supplied in one of four ways:
- create saved template: provide isCreateTemplate=true and template with templateName; the new template is used and its ID is returned
- one-time template: provide template without templateName and with isCreateTemplate=false (or omitted); it supplies omitted root configuration fields but is not saved

Root configuration fields always override their corresponding template value when present. template cannot be combined with invoiceTemplateId. The four root configuration fields (exportType, periodType, costMetric, displayLogoWithinPdf) are required only when neither invoiceTemplateId nor template is supplied.
Root configuration fields always override their corresponding template value when present. template cannot be combined with invoiceTemplateId. The four required root configuration fields (exportType, periodType, costMetric, displayLogoWithinPdf) are required only when neither invoiceTemplateId nor template is supplied. exportLayout is optional: PDF exports default to flatten, while nested selects the nested layout. Values are exact lowercase flatten or nested; omit exportLayout for CSV exports.

```
flexera-cli finops-billing invoices create [flags]
Expand All @@ -35,22 +35,23 @@ Validated illustrative body, when available (review before use):

```
--body string raw JSON body (inline | @file | @-); overrides body field flags
--cost-metric string costMetric (body); Cost metric to use for export. Required only when neither invoiceTemplateId nor template is supplied.; enum: ["billedCost","effectiveCost","modifiedBilledCost","modifiedEffectiveCost"]; illustrative example: "modifiedEffectiveCost"
--dimensions strings dimensions (body); Dimensions to include in export.; maxItems: 10; CLI: comma-separated values or repeated flag; illustrative example: ["Expedita consequatur labore voluptatum non et.","Accusamus consequatur.","Voluptate beatae illo."]
--cost-metric string costMetric (body); Cost metric to use for export. Required only when neither invoiceTemplateId nor template is supplied.; enum: ["billedCost","effectiveCost","modifiedBilledCost","modifiedEffectiveCost"]; illustrative example: "effectiveCost"
--dimensions strings dimensions (body); Dimensions to include in export.; maxItems: 10; CLI: comma-separated values or repeated flag; illustrative example: ["Odio illo ut.","Est eos alias omnis maxime excepturi.","Velit fugit rerum non modi voluptatem qui."]
--display-logo-within-pdf displayLogoWithinPdf (body); Whether to show logo in PDF export. Required only when neither invoiceTemplateId nor template is supplied.; illustrative example: false
--dry-run print the planned operation as JSON and exit without calling the API
--due-date string dueDate (body); Invoice due date.; format: date; illustrative example: "1993-12-03"
--end-date string endDate (body); required by API; Invoice range end date.; format: date; illustrative example: "1990-10-28"
--export-type string exportType (body); Export type. Required only when neither invoiceTemplateId nor template is supplied.; enum: ["pdf","csv"]; illustrative example: "pdf"
--free-text string freeText (body); Optional free text.; illustrative example: "Nulla numquam architecto eius pariatur."
--due-date string dueDate (body); Invoice due date.; format: date; illustrative example: "2001-06-25"
--end-date string endDate (body); required by API; Invoice range end date.; format: date; illustrative example: "1978-08-01"
--export-layout string exportLayout (body); PDF layout format. Exact lowercase flatten or nested; omitted PDF exports default to flatten. Must be omitted for CSV exports.; enum: ["flatten","nested"]; illustrative example: "flatten"
--export-type string exportType (body); Export type. Required only when neither invoiceTemplateId nor template is supplied.; enum: ["pdf","csv"]; illustrative example: "csv"
--free-text string freeText (body); Optional free text.; illustrative example: "Numquam quasi aut saepe dolorum sapiente molestias."
-h, --help help for create
-i, --interactive edit inputs in a terminal form, review a plan and approve with typed yes
--invoice-template-id string invoiceTemplateId (body); Optional saved invoice template to source default field values from. Cannot be combined with template. Opaque ID; resolved server-side and snapshotted into the invoice.; illustrative example: "Eius voluptatem et rerum minus."
--invoice-template-id string invoiceTemplateId (body); Optional saved invoice template to source default field values from. Cannot be combined with template. Opaque ID; resolved server-side and snapshotted into the invoice.; illustrative example: "Sed laborum corporis repellendus nisi."
--is-create-template isCreateTemplate (body); Whether to create and use a reusable invoice template from template properties.; API default: false; illustrative example: false
--issue-date string issueDate (body); Invoice issue date.; format: date; illustrative example: "1982-03-16"
--logo string logo (body); Optional logo payload.; illustrative example: "Iure dolorem animi atque quos."
--period-type string periodType (body); Configured period type. Required only when neither invoiceTemplateId nor template is supplied.; enum: ["chargePeriod","billPeriod","billingPeriod"]; illustrative example: "billPeriod"
--start-date string startDate (body); required by API; Invoice range start date.; format: date; illustrative example: "2005-03-29"
--issue-date string issueDate (body); Invoice issue date.; format: date; illustrative example: "1985-06-06"
--logo string logo (body); Optional logo payload.; illustrative example: "Molestias quos harum veritatis beatae quis."
--period-type string periodType (body); Configured period type. Required only when neither invoiceTemplateId nor template is supplied.; enum: ["chargePeriod","billPeriod","billingPeriod"]; illustrative example: "chargePeriod"
--start-date string startDate (body); required by API; Invoice range start date.; format: date; illustrative example: "2014-03-24"
--yes confirm the operation (required for destructive ops)
```

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/flexera-cli_finops-billing_invoices_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Illustrative only: replace uppercase tokens; provide your own request.json for b

```
-h, --help help for get
--id string id (path, required); Invoice export identifier; required by API; illustrative example: "Voluptates et."
--id string id (path, required); Invoice export identifier; required by API; illustrative example: "Repellat est et molestias molestiae voluptatem."
```

### Options inherited from parent commands
Expand Down
23 changes: 11 additions & 12 deletions docs/cli/flexera-cli_finops-billing_invoices_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,17 @@ Illustrative only: replace uppercase tokens; provide your own request.json for b
### Options

```
--bill-month string billMonth (query); Optional bill month filter.; pattern: "^\\d{4}-\\d{2}$"; illustrative example: "Cruz Fadel"
--customer-name string customerName (query); Optional customer name filter.; illustrative example: "Officia sed."
--export-type string exportType (query); Optional export type filter.; enum: ["pdf","csv"]; illustrative example: "csv"
--expression-filter string expressionFilter (query); OData-style expression evaluated against each returned resource. Attribute names are case-sensitive and operators are case-insensitive. String eq, ne, and in comparisons are case-sensitive; co performs case-insensitive substring matching. Date values use YYYY-MM-DD; date-time values use ISO-8601 and are normalized to UTC; billMonth uses YYYY-MM. Missing fiel... (see cli schema); illustrative example: "customerName co 'Acme' and exportType eq 'pdf'"
--filter string filter (query); Legacy substring search of the stored invoice generation filter JSON. This parameter does not accept OData expressions.; illustrative example: "Facere dolorum est velit adipisci tenetur."
--group-by-count int groupByCount (query); Optional group-by dimension count filter.; illustrative example: 17118634271918162000
-h, --help help for list
--limit int limit (query); Page size (default 10, max 200); minimum: 1; maximum: 200; API default: 10; illustrative example: 7
--no-paginate return only the first page (do not follow nextPage)
--order-by string orderBy (query); Optional orderBy query allows to specify an expression for determining what values are used to order the entities. Multiple expressions can be specified using comma separated values.; illustrative example: "updatedAt desc"
--skip-token string resume pagination from this token; An opaque token to be provided when requesting a subsequent page after receiving a partial response. Partial responses will include a "nextPage" attribute in their response body, which contains the URL of the next page including the appropriate skipToken.
--status string status (query); Optional status filter.; illustrative example: "Est ullam."
--bill-month string billMonth (query); Optional bill month filter.; pattern: "^\\d{4}-\\d{2}$"; illustrative example: "Cecilia Durgan PhD"
--customer-name string customerName (query); Optional customer name filter.; illustrative example: "Ratione aut illum sunt sunt."
--export-type string exportType (query); Optional export type filter.; enum: ["pdf","csv"]; illustrative example: "csv"
--filter string filter (query); Optional filter text.; illustrative example: "Illo nisi nihil quo dolorum."
--group-by-count int groupByCount (query); Optional group-by dimension count filter.; illustrative example: 1143869422251415800
-h, --help help for list
--limit int limit (query); Page size (default 10, max 200); minimum: 1; maximum: 200; API default: 10; illustrative example: 140
--no-paginate return only the first page (do not follow nextPage)
--order-by string orderBy (query); Optional orderBy query allows to specify an expression for determining what values are used to order the entities. Multiple expressions can be specified using comma separated values.; illustrative example: "updatedAt desc"
--skip-token string resume pagination from this token; An opaque token to be provided when requesting a subsequent page after receiving a partial response. Partial responses will include a "nextPage" attribute in their response body, which contains the URL of the next page including the appropriate skipToken.
--status string status (query); Optional status filter.; illustrative example: "Porro tempore."
```

### Options inherited from parent commands
Expand Down
Loading