Invoice.md

Invoice

Properties

Name	Type	Description	Notes
created	datetime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	str	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	datetime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
version_id	str	{ "description" : "Version identifier of the invoice.", "verbs":["GET"] }	[optional]
id	str	{ "description" : "Unique identifier for the invoice.", "verbs":["GET"] }	[optional]
crm_id	str	{ "description" : "CRM identifier of the invoice.", "verbs":["PUT","GET"] }	[optional]
subscription_id	str	{ "description" : "", "verbs":["GET"] }	[optional]
subscription_version_id	str	{ "description" : "", "verbs":["GET"] }
account_id	str	{ "description" : "", "verbs":["GET"] }
organization_id	str	{ "description" : "", "verbs":[] }
parent_invoice_id	str	{ "description" : "", "verbs":[] }	[optional]
name	str	{ "description" : "The name of the invoice", "verbs":[] }	[optional]
description	str	{ "description" : "The description of the invoice", "verbs":[] }	[optional]
state	str	{ "description" : "Initially an invoice is set as unpaid. Once payment for the full value of the invoice has been received it is marked as paid. An invoice may be paid from various sources including cards, coupons or manual payments.", "verbs":["GET"] }
issued	datetime	{ "description" : "The UTC DateTime when the invoice was first issued.", "verbs":["GET"] }	[optional]
period_start	datetime	{ "description" : "Start of the period being billed by this invoice, UTC DateTime", "verbs":["GET"] }	[optional]
period_end	datetime	{ "description" : "End of the period being billed by this invoice, UTC DateTime.", "verbs":["GET"] }	[optional]
due	datetime	{ "description" : "Date this invoice is due, UTC DateTime.", "verbs":["GET"] }	[optional]
deleted	bool	{ "description" : "Indicates if an invoice has been retired. If an invoice has been retired it can still be retrieved using the appropriate flag on API requests. Generally invoices will not be retired.", "verbs":[] }	[default to False]
total_execution_attempts	int	{ "description" : "Number of payment attempts for this invoice. This includes any manual execution attempts.", "verbs":["GET"] }	[optional]
last_execution_attempt	datetime	{ "description" : "UTC DateTime of the invoice's last execution attempt. This was the last time an attempt was made to take payment for this invoice.", "verbs":["GET"] }	[optional]
next_execution_attempt	datetime	{ "description" : "UTC DateTime of the invoice's next execution attempt. If the next execution attempt is greater than the period end for this invoice, the invoice will not receive another automatic execution attempt.", "verbs":["GET"] }	[optional]
final_execution_attempt	datetime	{ "description" : "UTC DateTime of the invoice's final execution attempt. The final execution attempt. This may be less than the next execution attempt if the next execution attempt never occurred.", "verbs":["GET"] }	[optional]
payment_received	datetime	{ "description" : "UTC DateTime specifying when payment was received for the invoice.", "verbs":["GET"] }	[optional]
currency	str	{ "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["GET"] }
cost_excluding_tax	float	{ "description" : "Cost of the invoice exclusive of tax.", "verbs":["GET"] }
invoice_cost	float	{ "description" : "Cost of the invoice inclusive of tax.", "verbs":["GET"] }
non_discounted_cost	float	Cost of the invoice before discounts, inclusive of tax.
non_discounted_cost_excluding_tax	float	Cost of the invoice before discounts, inclusive of tax.
invoice_paid	float	{ "description" : "Total amount of the invoice currently paid for. As the invoice may be paid by multiple payments, for example partly paid for by a voucher and then paid for by a card, this indicates the current paid amount of the invoice.", "verbs":["GET"] }	[optional]
discount_amount	float	{ "description" : "The amount of discounts for the invoice.", "verbs":["GET"] }	[optional]
discount_amount_excluding_tax	float	{ "description" : "The amount of discounts for the invoice excluding tax.", "verbs":["GET"] }	[optional]
invoice_refunded	float	{ "description" : "Total amount of the invoice refunded.", "verbs":["GET"] }	[optional]
credit_rolled_over	float	{ "description" : "The amount of credit to be returned to the pool.", "verbs":["GET"] }
credit_rolled_over_excluding_tax	float	{ "description" : "The amount of credit to be returned to the pool excluding tax.", "verbs":["GET"] }	[optional]
type	str	{ "description" : "The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.", "verbs":["GET"] }
locked	str	{ "description" : "If the subscription is locked, it will not be processed by the system", "verbs":[] }	[optional]
managed_by	str	{ "description" : "Which system is responsible for managing the subscription.", "verbs":[] }	[optional]
initial_invoice	bool	{ "description" : "Is this an initial invoice. An initial invoice is the first invoice generated for a subscription. Initial invoices will not have dunning applied to them and as such will only have a single payment attempt. For trial periods, the trial invoice is the initial invoice.", "verbs":["GET"] }	[default to False]
version_number	int	{ "description" : "The version number of the Invoice. The first version of an Invoice is version number 1", "verbs":["GET"] }
invoice_lines	list[InvoiceLine]	{ "description" : "The collection of invoice-lines associated with the invoice.", "verbs":["GET"] }	[optional]
tax_lines	list[InsertableBillingEntity]		[optional]
invoice_payments	list[InvoicePayment]	{ "description" : "Payments used for this invoice. Multiple payments may be associated with the invoice.", "verbs":["GET"] }	[optional]
invoice_refunds	list[Refund]	{ "description" : "Refunds associated with this invoice. Multiple refunds may be associated with the invoice.", "verbs":["GET"] }	[optional]
invoice_credit_notes	list[CreditNote]	{ "description" : "Credit Notes associated with this invoice. Multiple credit notes may be associated with the invoice.", "verbs":["GET"] }	[optional]
charges	list[SubscriptionCharge]		[optional]
children	list[Invoice]		[optional]

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