Invoice.md

Invoice

Properties

Name	Type	Description	Notes
id	str	A unique identifier for an object.	[optional] [readonly]
downstream_id	str, none_type	The third-party API ID of original entity	[optional] [readonly]
type	str, none_type	Invoice type	[optional]
number	str, none_type	Invoice number.	[optional]
customer	LinkedCustomer		[optional]
company_id	str, none_type	The company or subsidiary id the transaction belongs to	[optional]
invoice_date	date, none_type	Date invoice was issued - YYYY-MM-DD.	[optional]
due_date	date, none_type	The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.	[optional]
terms	str, none_type	Terms of payment.	[optional]
po_number	str, none_type	A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.	[optional]
reference	str, none_type	Optional invoice reference.	[optional]
status	str, none_type	Invoice status	[optional]
invoice_sent	bool	Invoice sent to contact/customer.	[optional]
currency	Currency		[optional]
currency_rate	float, none_type	Currency Exchange Rate at the time entity was recorded/generated.	[optional]
tax_inclusive	bool, none_type	Amounts are including tax	[optional]
sub_total	float, none_type	Sub-total amount, normally before tax.	[optional]
total_tax	float, none_type	Total tax amount applied to this invoice.	[optional]
tax_code	str, none_type	Applicable tax id/code override if tax is not supplied on a line item basis.	[optional]
discount_percentage	float, none_type	Discount percentage applied to this invoice.	[optional]
discount_amount	float, none_type	Discount amount applied to this invoice.	[optional]
total	float, none_type	Total amount of invoice, including tax.	[optional]
balance	float, none_type	Balance of invoice due.	[optional]
deposit	float, none_type	Amount of deposit made to this invoice.	[optional]
customer_memo	str, none_type	Customer memo	[optional]
tracking_category	DeprecatedLinkedTrackingCategory		[optional]
tracking_categories	LinkedTrackingCategories		[optional]
line_items	[InvoiceLineItem]		[optional]
billing_address	Address		[optional]
shipping_address	Address		[optional]
template_id	str, none_type	Optional invoice template	[optional]
source_document_url	str, none_type	URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.	[optional]
payment_allocations	[InvoicePaymentAllocations], none_type	IDs of payments made on the invoice	[optional]
payment_method	str, none_type	Payment method used for the transaction, such as cash, credit card, bank transfer, or check	[optional]
channel	str, none_type	The channel through which the transaction is processed.	[optional]
language	str, none_type	language code according to ISO 639-1. For the United States - EN	[optional]
accounting_by_row	bool, none_type	Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.	[optional]
bank_account	BankAccount		[optional]
ledger_account	LinkedLedgerAccount		[optional]
custom_mappings	CustomMappings		[optional]
custom_fields	[CustomField]		[optional]
row_version	str, none_type	A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.	[optional]
updated_by	str, none_type	The user who last updated the object.	[optional] [readonly]
created_by	str, none_type	The user who created the object.	[optional] [readonly]
updated_at	datetime, none_type	The date and time when the object was last updated.	[optional] [readonly]
created_at	datetime, none_type	The date and time when the object was created.	[optional] [readonly]
pass_through	PassThroughBody		[optional]

[Back to Model list] [Back to API list] [Back to README]