EndPoint List All Invoices

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

get_quotes

Description

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. [API Help]

Parameters

Parameter

Label

Required

Options

Description

customer

Customer Id

Only return invoices for the customer specified by this customer Id.

status

Status (draft or open or paid or uncollectible or void)

Option	Value
draft	draft
open	open
paid	paid
uncollectible	uncollectible
void	void

The status of the invoice, one of draft, open, paid, uncollectible, or void

Output Columns

Label	DataType	Length	Raw
Id	DT_WSTR	108	False
object	DT_WSTR	20	False
amount_subtotal	DT_I8	0	False
amount_total	DT_I8	0	False
application	DT_WSTR	1020	False
application_fee_amount	DT_WSTR	1020	False
application_fee_percent	DT_WSTR	1020	False
automatic_tax_enabled	DT_BOOL	0	False
automatic_tax_status	DT_WSTR	1020	False
collection_method	DT_WSTR	80	False
recurring_amount_subtotal	DT_I8	0	False
recurring_amount_total	DT_I8	0	False
recurring_interval	DT_WSTR	20	False
recurring_interval_count	DT_I8	0	False
recurring_total_amount_discount	DT_I8	0	False
recurring_total_amount_shipping	DT_I8	0	False
recurring_total_amount_tax	DT_I8	0	False
upfront_amount_subtotal	DT_I8	0	False
upfront_amount_total	DT_I8	0	False
upfront_total_amount_discount	DT_I8	0	False
upfront_total_amount_shipping	DT_I8	0	False
upfront_total_amount_tax	DT_I8	0	False
Created	DT_DBTIMESTAMP	0	False
currency	DT_WSTR	12	False
customer	DT_WSTR	72	False
default_tax_rates	DT_WSTR	8	False
description	DT_WSTR	140	False
discounts	DT_WSTR	8	False
expires_at	DT_DBTIMESTAMP	0	False
footer	DT_WSTR	80	False
from_quote	DT_WSTR	1020	False
header	DT_WSTR	80	False
invoice	DT_WSTR	1020	False
invoice_settings_days_until_due	DT_WSTR	1020	False
livemode	DT_BOOL	0	False
number	DT_WSTR	72	False
on_behalf_of	DT_WSTR	1020	False
status	DT_WSTR	16	False
status_transitions_accepted_at	DT_DBTIMESTAMP	0	False
status_transitions_canceled_at	DT_DBTIMESTAMP	0	False
status_transitions_finalized_at	DT_DBTIMESTAMP	0	False
subscription	DT_WSTR	1020	False
subscription_data_description	DT_WSTR	1020	False
subscription_data_effective_date	DT_DBTIMESTAMP	0	False
subscription_data_trial_period_days	DT_WSTR	1020	False
subscription_schedule	DT_WSTR	1020	False
test_clock	DT_WSTR	1020	False
total_amount_discount	DT_I8	0	False
total_amount_shipping	DT_I8	0	False
total_details_amount_tax	DT_I8	0	False
transfer_data	DT_WSTR	1020	False

Input Columns

Label	DataType	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.