OpenMax
Free Trial

Apps API · Billing Invoice

Billing Invoice: 6 endpoints

← All groups

GET /api/v1/billing/invoice-profile

Get the international invoice Bill to profile

Scope: billing:invoice:read · Called with: appToken · operationId: get-billing-intl-invoice-profile

Required app scope: billing:invoice:read.

Returns the org's Bill to profile used on international invoices, or data=null when it was never filled. Requires org-owner. Response wrapped in standard envelope.

Responses

GET /api/v1/billing/invoice/applications

List invoice applications

Scope: billing:invoice:read · Called with: appToken · operationId: list-billing-invoice-applications

Required app scope: billing:invoice:read.

Lists the org's invoice application history, optionally filtered by status and a created_at window. Page-based: increment page while pagination.has_more is true. Any org member. org_id is taken from the caller's Principal. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
status query string Optional status filter (payment_create_pending|issuing|issued|failed|voiding|voided); empty = all
created_from query string (date-time) Optional created_at lower bound (RFC3339)
created_to query string (date-time) Optional created_at upper bound (RFC3339)
page query integer (int32) Page number (1-based; default: 1)
page_size query integer (int32) Items per page (omitted: server default, 50 for history lists, 100 for the credit statement; max 200)
order_by query string Sorting is not supported yet; any non-empty value is rejected with 400

Responses

GET /api/v1/billing/invoice/applications/{id}

Get an invoice application

Scope: billing:invoice:read · Called with: appToken · operationId: get-billing-invoice-application

Required app scope: billing:invoice:read.

Returns a single invoice application with all fields (legal invoice number / tax amount / failure reason / red-void evidence). An unknown id (or one outside the caller's org) is 404. Any org member. org_id is taken from the caller's Principal. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
id path integer (int64) yes Invoice application id (InvoiceApplication.id)

Responses

GET /api/v1/billing/invoice/applications/{id}/artifact

Get an issued invoice's download handles

Scope: billing:invoice:read · Called with: appToken · operationId: get-billing-invoice-artifact

Required app scope: billing:invoice:read.

Returns the PDF/OFD download URLs for an issued invoice. Only issued applications (and the original artifact of a voided one) have an artifact; a not-yet-issued application returns 412 (FailedPrecondition). An unknown id (or one outside the caller's org) is 404. Any org member. org_id is taken from the caller's Principal. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
id path integer (int64) yes Invoice application id (InvoiceApplication.id)

Responses

GET /api/v1/billing/invoice/invoiceable-orders

List invoiceable orders

Scope: billing:invoice:read · Called with: appToken · operationId: list-billing-invoiceable-orders

Required app scope: billing:invoice:read.

Lists the org's paid orders and their invoicing state (invoiceable | issuing | issued). only_invoiceable=true narrows to orders that can still be invoiced. Page-based: increment page while pagination.has_more is true. Any org member. org_id is taken from the caller's Principal. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
only_invoiceable query boolean true = only orders that can still be invoiced; false (default) = also include issuing / issued orders with their status
page query integer (int32) Page number (1-based; default: 1)
page_size query integer (int32) Items per page (omitted: server default, 50 for history lists, 100 for the credit statement; max 200)
order_by query string Sorting is not supported yet; any non-empty value is rejected with 400

Responses

GET /api/v1/billing/invoice/summary

Get domestic invoice summary

Scope: billing:invoice:read · Called with: appToken · operationId: get-billing-invoice-summary

Required app scope: billing:invoice:read.

Returns the org's domestic-invoice aggregate card: remaining_invoiceable_minor (Σ still-invoiceable order amounts) and issued_minor (Σ already-issued order amounts), in currency minor units. A client should disable its invoice-request entry when remaining_invoiceable_minor is 0. Read-only; derived server-side from the same invoice occupancy/applications as the per-order status. Any org member. org_id is taken from the caller's Principal. Response wrapped in standard envelope.

Responses