reports

Get invoice lines report

Requires the REPORT_GENERATE_REQUEST.CREATE permission.

get/v{version}/reports/invoice-lines-overview

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/reports/invoice-lines-overview
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

customer_idstring

Filter based of customer ID

statuses[]string[]

Filter invoices based on invoice status(es)

invoice_datestring

Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).

paidstring

Filter invoices based on whether they're paid or not (true or false)

on_holdstring

Filter invoices based on whether they're on hold or not (true or false)

pricing_plan_subscription_idstring

Filter invoices by the pricing plan subscription id

product_idstring

Filter invoices containing a product resource id

product_item_idstring

Filter invoices containing a product item resource id

include_periodsboolean

Indicates whether the response should include period and group data (true or false)

include_linesboolean

Indicates whether the response should include invoice lines (true or false)

limitinteger

The amount of records shown in the list

pageinteger

The page which is going to be shown

order_bystring

The parameter by which the response is ordered.

order_directionstring

The order direction by which the response is ordered.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
customer_idstring nullable

Resource ID of type CUSTOMER

invoice_idstring nullable

Resource ID of type INVOICE

generate_atstring date-time
report_code'INVOICE' | 'INVOICE_USAGE' | 'INVOICE_HEADER' | 'INVOICE_LINE' | 'INVOICE_TAX' | 'INVOICE_COMMITMENT' | 'E_INVOICING' | 'CHILD_PARENT_BREAKDOWN' | 'CHILD_PARENT_BREAKDOWN_PLATFORM' | 'NOT_MATCHED_METER_DATA' | 'DUPLICATE_METER_DATA' | 'METERING' | 'CUSTOMER' | 'PRODUCT' | 'PRICING_PLAN_SUBSCRIPTION' | 'PAYMENT' | 'PRICING' | 'REVENUE_RECOGNITION' | 'CLAUSES' | 'REPROCESS'
statusstring nullable
report_subscription_idstring nullable
report_configuration_idstring

Resource ID of type REPORT_CONFIGURATION

run_typestring nullable
format'CSV' | 'JSON_LINES' | 'PARQUET' | 'AVRO'

Changes

No recorded changes to this operation across all 1 revision of this API.