List invoices
GET {{baseUrl}}/customers/:customer_id/invoices?limit=<integer>&next_page=<string>&status=<string>&skip_zero_qty_line_items=<boolean>&sort=date_asc&credit_type_id=<string>&starting_on=<dateTime>&ending_before=<dateTime>
List all invoices for a given customer, optionally filtered by status, date range, and/or credit type.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | string | Max number of results that should be returned | |
next_page | string | Cursor that indicates where the next page of results should start. | |
status | string | Invoice status, e.g. DRAFT, FINALIZED, or VOID | |
skip_zero_qty_line_items | string | If set, all zero quantity line items will be filtered out of the response | |
sort | string | Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_asc. | |
credit_type_id | string | Only return invoices for the specified credit type | |
starting_on | string | RFC 3339 timestamp (inclusive). Invoices will only be returned for billing periods that start at or after this time. | |
ending_before | string | RFC 3339 timestamp (exclusive). Invoices will only be returned for billing periods that end before this time. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":"\u003cuuid\u003e","customer_id":"\u003cuuid\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"line_items":[{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"group_key":"\u003cstring\u003e","group_value":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","unit_price":"\u003cnumber\u003e","product_id":"\u003cuuid\u003e","product_custom_fields":{"consequat_47":"\u003cstring\u003e","enim_1":"\u003cstring\u003e"},"product_type":"\u003cstring\u003e","netsuite_item_id":"\u003cstring\u003e","is_prorated":"\u003cboolean\u003e","starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e","commit_id":"\u003cuuid\u003e","commit_custom_fields":{"quis7d":"\u003cstring\u003e","ex_2c":"\u003cstring\u003e","qui_b8":"\u003cstring\u003e","reprehenderit_5":"\u003cstring\u003e","dolor3":"\u003cstring\u003e"},"commit_segment_id":"\u003cuuid\u003e","commit_type":"\u003cstring\u003e","commit_netsuite_sales_order_id":"\u003cstring\u003e","commit_netsuite_item_id":"\u003cstring\u003e","postpaid_commit":{"id":"\u003cuuid\u003e"},"reseller_type":"GCP","sub_line_items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"incididunt0":"\u003cstring\u003e","ut_a3":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"},{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"sint_e":"\u003cstring\u003e","ut_5":"\u003cstring\u003e","velit5":"\u003cstring\u003e","nisi_a":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"}],"custom_fields":{"magnae":"\u003cstring\u003e","sed_0b":"\u003cstring\u003e"},"pricing_group_values":{"Lorem_11":"\u003cstring\u003e"},"presentation_group_values":{"enim_7f":"\u003cstring\u003e","velit_f":"\u003cstring\u003e"},"metadata":"\u003cstring\u003e","netsuite_invoice_billing_start":"\u003cdateTime\u003e","netsuite_invoice_billing_end":"\u003cdateTime\u003e","professional_service_id":"\u003cuuid\u003e","professional_service_custom_fields":{"anim_c9":"\u003cstring\u003e","Lorem_":"\u003cstring\u003e"},"scheduled_charge_id":"\u003cuuid\u003e","scheduled_charge_custom_fields":{"sunt__cd":"\u003cstring\u003e"}},{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"group_key":"\u003cstring\u003e","group_value":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","unit_price":"\u003cnumber\u003e","product_id":"\u003cuuid\u003e","product_custom_fields":{"nonf":"\u003cstring\u003e","nostrudc7":"\u003cstring\u003e","labore73":"\u003cstring\u003e"},"product_type":"\u003cstring\u003e","netsuite_item_id":"\u003cstring\u003e","is_prorated":"\u003cboolean\u003e","starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e","commit_id":"\u003cuuid\u003e","commit_custom_fields":{"dolor22":"\u003cstring\u003e","dolore_5e":"\u003cstring\u003e"},"commit_segment_id":"\u003cuuid\u003e","commit_type":"\u003cstring\u003e","commit_netsuite_sales_order_id":"\u003cstring\u003e","commit_netsuite_item_id":"\u003cstring\u003e","postpaid_commit":{"id":"\u003cuuid\u003e"},"reseller_type":"AWS","sub_line_items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"tempor_63":"\u003cstring\u003e","aliqua_":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"},{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"ametf6":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"}],"custom_fields":{"dolore_7ae":"\u003cstring\u003e","labore_b":"\u003cstring\u003e"},"pricing_group_values":{"irure_bc":"\u003cstring\u003e"},"presentation_group_values":{"in_107":"\u003cstring\u003e"},"metadata":"\u003cstring\u003e","netsuite_invoice_billing_start":"\u003cdateTime\u003e","netsuite_invoice_billing_end":"\u003cdateTime\u003e","professional_service_id":"\u003cuuid\u003e","professional_service_custom_fields":{"dolor_a":"\u003cstring\u003e","ad_4e":"\u003cstring\u003e","Lorem_b2":"\u003cstring\u003e"},"scheduled_charge_id":"\u003cuuid\u003e","scheduled_charge_custom_fields":{"laborum_b":"\u003cstring\u003e"}}],"status":"\u003cstring\u003e","total":"\u003cnumber\u003e","type":"\u003cstring\u003e","customer_custom_fields":{"consectetur_30":"\u003cstring\u003e"},"netsuite_sales_order_id":"\u003cstring\u003e","salesforce_opportunity_id":"\u003cstring\u003e","net_payment_terms_days":"\u003cnumber\u003e","invoice_adjustments":[{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"credit_grant_id":"\u003cstring\u003e","credit_grant_custom_fields":{"tempor7ba":"\u003cstring\u003e","veniam_c":"\u003cstring\u003e"}},{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"credit_grant_id":"\u003cstring\u003e","credit_grant_custom_fields":{"dolore_e28":"\u003cstring\u003e","culpa_9a":"\u003cstring\u003e"}}],"start_timestamp":"\u003cdateTime\u003e","end_timestamp":"\u003cdateTime\u003e","issued_at":"\u003cdateTime\u003e","created_at":"\u003cdateTime\u003e","subtotal":"\u003cnumber\u003e","external_invoice":{"billing_provider_type":"azure_marketplace","invoice_id":"\u003cstring\u003e","issued_at_timestamp":"\u003cdateTime\u003e","external_status":"SKIPPED"},"plan_id":"\u003cuuid\u003e","plan_name":"\u003cstring\u003e","plan_custom_fields":{"nisi554":"\u003cstring\u003e","exercitation1":"\u003cstring\u003e"},"contract_id":"\u003cuuid\u003e","contract_custom_fields":{"aliquip75":"\u003cstring\u003e","Duis_0":"\u003cstring\u003e","nulla_d3":"\u003cstring\u003e"},"amendment_id":"\u003cuuid\u003e","correction_record":{"reason":"\u003cstring\u003e","memo":"\u003cstring\u003e","corrected_invoice_id":"\u003cuuid\u003e","corrected_external_invoice":{"billing_provider_type":"custom","invoice_id":"\u003cstring\u003e","issued_at_timestamp":"\u003cdateTime\u003e","external_status":"FINALIZED"}},"reseller_royalty":{"reseller_type":"GCP_PRO_SERVICE","netsuite_reseller_id":"\u003cstring\u003e","fraction":"\u003cstring\u003e","aws_options":{"aws_account_number":"\u003cstring\u003e","aws_payer_reference_id":"\u003cstring\u003e","aws_offer_id":"\u003cstring\u003e"},"gcp_options":{"gcp_account_id":"\u003cstring\u003e","gcp_offer_id":"\u003cstring\u003e"}},"custom_fields":{"mollit_a":"exercitation occaecat quis mollit","voluptate1":31538138},"billable_status":"billable"},{"id":"\u003cuuid\u003e","customer_id":"\u003cuuid\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"line_items":[{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"group_key":"\u003cstring\u003e","group_value":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","unit_price":"\u003cnumber\u003e","product_id":"\u003cuuid\u003e","product_custom_fields":{"ad_86":"\u003cstring\u003e","consequat_5":"\u003cstring\u003e"},"product_type":"\u003cstring\u003e","netsuite_item_id":"\u003cstring\u003e","is_prorated":"\u003cboolean\u003e","starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e","commit_id":"\u003cuuid\u003e","commit_custom_fields":{"ex_16":"\u003cstring\u003e","officia5":"\u003cstring\u003e"},"commit_segment_id":"\u003cuuid\u003e","commit_type":"\u003cstring\u003e","commit_netsuite_sales_order_id":"\u003cstring\u003e","commit_netsuite_item_id":"\u003cstring\u003e","postpaid_commit":{"id":"\u003cuuid\u003e"},"reseller_type":"AWS_PRO_SERVICE","sub_line_items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"consequat_1f":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"},{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"ut_5":"\u003cstring\u003e","aute031":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"}],"custom_fields":{"consequat_7":"\u003cstring\u003e"},"pricing_group_values":{"sit0a":"\u003cstring\u003e","ina41":"\u003cstring\u003e"},"presentation_group_values":{"enim7":"\u003cstring\u003e","quisc":"\u003cstring\u003e"},"metadata":"\u003cstring\u003e","netsuite_invoice_billing_start":"\u003cdateTime\u003e","netsuite_invoice_billing_end":"\u003cdateTime\u003e","professional_service_id":"\u003cuuid\u003e","professional_service_custom_fields":{"amet388":"\u003cstring\u003e","mollite":"\u003cstring\u003e"},"scheduled_charge_id":"\u003cuuid\u003e","scheduled_charge_custom_fields":{"laborumaaa":"\u003cstring\u003e"}},{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"group_key":"\u003cstring\u003e","group_value":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","unit_price":"\u003cnumber\u003e","product_id":"\u003cuuid\u003e","product_custom_fields":{"dolor_8":"\u003cstring\u003e"},"product_type":"\u003cstring\u003e","netsuite_item_id":"\u003cstring\u003e","is_prorated":"\u003cboolean\u003e","starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e","commit_id":"\u003cuuid\u003e","commit_custom_fields":{"fugiat2d8":"\u003cstring\u003e","consequat4":"\u003cstring\u003e","enim29":"\u003cstring\u003e"},"commit_segment_id":"\u003cuuid\u003e","commit_type":"\u003cstring\u003e","commit_netsuite_sales_order_id":"\u003cstring\u003e","commit_netsuite_item_id":"\u003cstring\u003e","postpaid_commit":{"id":"\u003cuuid\u003e"},"reseller_type":"GCP_PRO_SERVICE","sub_line_items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"irure_e":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"},{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e","custom_fields":{"tempor_65e":"\u003cstring\u003e"},"price":"\u003cnumber\u003e","charge_id":"\u003cuuid\u003e","credit_grant_id":"\u003cuuid\u003e","tier_period":{"starting_at":"\u003cdateTime\u003e","ending_before":"\u003cdateTime\u003e"},"tiers":[{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"},{"starting_at":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","subtotal":"\u003cnumber\u003e"}],"start_date":"\u003cdateTime\u003e","end_date":"\u003cdateTime\u003e"}],"custom_fields":{"incididunt__2":"\u003cstring\u003e","labore_140":"\u003cstring\u003e","nostrud_7d5":"\u003cstring\u003e","Excepteurc32":"\u003cstring\u003e"},"pricing_group_values":{"pariatur_89f":"\u003cstring\u003e"},"presentation_group_values":{"laborisc":"\u003cstring\u003e","velit_44":"\u003cstring\u003e"},"metadata":"\u003cstring\u003e","netsuite_invoice_billing_start":"\u003cdateTime\u003e","netsuite_invoice_billing_end":"\u003cdateTime\u003e","professional_service_id":"\u003cuuid\u003e","professional_service_custom_fields":{"irure_23":"\u003cstring\u003e","dolorecb_":"\u003cstring\u003e","laboris_4d":"\u003cstring\u003e","laboris_58":"\u003cstring\u003e"},"scheduled_charge_id":"\u003cuuid\u003e","scheduled_charge_custom_fields":{"deserunt_0":"\u003cstring\u003e"}}],"status":"\u003cstring\u003e","total":"\u003cnumber\u003e","type":"\u003cstring\u003e","customer_custom_fields":{"in0_":"\u003cstring\u003e"},"netsuite_sales_order_id":"\u003cstring\u003e","salesforce_opportunity_id":"\u003cstring\u003e","net_payment_terms_days":"\u003cnumber\u003e","invoice_adjustments":[{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"credit_grant_id":"\u003cstring\u003e","credit_grant_custom_fields":{"sedbe":"\u003cstring\u003e","occaecat_2":"\u003cstring\u003e"}},{"name":"\u003cstring\u003e","total":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"credit_grant_id":"\u003cstring\u003e","credit_grant_custom_fields":{"veniam_53d":"\u003cstring\u003e","irure_dc7":"\u003cstring\u003e","deserunt_1":"\u003cstring\u003e","sit_823":"\u003cstring\u003e","aute_39":"\u003cstring\u003e"}}],"start_timestamp":"\u003cdateTime\u003e","end_timestamp":"\u003cdateTime\u003e","issued_at":"\u003cdateTime\u003e","created_at":"\u003cdateTime\u003e","subtotal":"\u003cnumber\u003e","external_invoice":{"billing_provider_type":"netsuite","invoice_id":"\u003cstring\u003e","issued_at_timestamp":"\u003cdateTime\u003e","external_status":"SENT"},"plan_id":"\u003cuuid\u003e","plan_name":"\u003cstring\u003e","plan_custom_fields":{"velit_8ed":"\u003cstring\u003e","reprehenderita_e":"\u003cstring\u003e"},"contract_id":"\u003cuuid\u003e","contract_custom_fields":{"officia_39b":"\u003cstring\u003e","est6":"\u003cstring\u003e","Ut_97":"\u003cstring\u003e","sedbc":"\u003cstring\u003e"},"amendment_id":"\u003cuuid\u003e","correction_record":{"reason":"\u003cstring\u003e","memo":"\u003cstring\u003e","corrected_invoice_id":"\u003cuuid\u003e","corrected_external_invoice":{"billing_provider_type":"aws_marketplace","invoice_id":"\u003cstring\u003e","issued_at_timestamp":"\u003cdateTime\u003e","external_status":"QUEUED"}},"reseller_royalty":{"reseller_type":"GCP_PRO_SERVICE","netsuite_reseller_id":"\u003cstring\u003e","fraction":"\u003cstring\u003e","aws_options":{"aws_account_number":"\u003cstring\u003e","aws_payer_reference_id":"\u003cstring\u003e","aws_offer_id":"\u003cstring\u003e"},"gcp_options":{"gcp_account_id":"\u003cstring\u003e","gcp_offer_id":"\u003cstring\u003e"}},"custom_fields":{"deserunt0b":74232543.21066883,"nulla_c_":97759402.51921394,"dolor_d":true},"billable_status":"billable"}],"next_page":"\u003cstring\u003e"}