Invoice Object

The invoice resource represents a posted invoice that has caused accounting ledger movements. It includes the amount charged, identifying information about the customer being charged, changes to the Accounts Receivable balance, tax information, and information on the scheduling of payments.

Invoice Object Fields

Property	Type	Description
`invoiceNumber`	Integer	The invoice number as shown to the customer
`invoiceSignature`	String	The signature, with formatting, that appears on the invoice when viewed as PDF or HTML.
`poNumber`	String	The standing PO number
`effectiveTimestamp`	DateTime	The effective timestamp of the invoice
`postedTimestamp`	DateTime	The timestamp of when the invoice was posted
`modifiedTimestamp`	DateTime	The timestamp for when the invoice was last modified
`charges`	List of Objects. See Invoices And Statements: Charges	The charges associated with this invoice
`subtotal`	Decimal	The subtotal of the invoice
`invoiceAmount`	Decimal	The amount being invoiced
`totalPayments`	Decimal	The sum of the payments made so far
`unsettled`	Boolean	If using the Fusebill Payments gateway, then this is true if any payment note has a pending settlement status
`outstandingBalance`	Decimal	The sum of the amounts still owing
`terms`	Enum:{Net0, Net5, Net7, Net10, Net15, Net21, Net30, Net45, Net60, Net75, Net90, MFI1, DayOfMonth1, DayOfMonth2, DayOfMonth3, ... DayOfMonth29, DayOfMonth30, DayOfMonth31}	The billing term for this invoice.
`defaultTerms`	Enum:{Net0, Net5, Net7, Net10, Net15, Net21, Net30, Net45, Net60, Net75, Net90, MFI1, DayOfMonth1, DayOfMonth2, DayOfMonth3, ... DayOfMonth29, DayOfMonth30, DayOfMonth31}	Terms can be overridden on ready draft invoices. This is the terms that would have been used if no override occurred.
`isDefaultTerms`	Boolean	If true, then `defaultTerms` is being used to determine the due date instead of `terms`
`customerId`	Integer	The Fusebill generated ID that uniquely identifies the customer
`invoiceCustomer`	Object	A snapshot of the customer at the time the invoice was posted. Contains a slightly summarized version of the customer object described in Customers: Customer Object
`invoiceCustomerAddressPreference`	Object. See Customer: Customer Address Preference for details	The address preference of the customer.
`sumOfCreditNotes`	Decimal	The sum of the credit notes for this invoice
`totalWriteoffs`	Decimal	The sum of the write offs for this invoice
`taxes`	A list of Objects. Defined below	The taxes on this invoice
`totalDiscount`	Decimal	The sum of the discounts applied on this invoice
`paymentSchedule`	A list of Objects. Defined below	The invoice can be set to be paid in installments. If this is the case, this list dictates the schedule.
`notes`	String	Billing agents can write notes on draft invoices. Once posted the note is final. [Max Length: 500 characters]
`customerReferenceValue`	String	The reference value of the customer. Intended to be your internal ID for the customer
`openingArBalance`	Decimal	The opening balance of accounts receivable at invoice post
`closingArBalance`	Decimal	The closing balance of accounts receivable at invoice post
`invoiceInMemoryOnly`	Boolean	For internal use
`invoiceRevisions`	List of objects. Defined below.	A list of changes made to the invoice after it was posted
`totalTaxes`	Decimal	The summation of the applied taxes
`rollUpPdf`	Boolean	Is true if the customer billing settings at the time of invoice posting specify to summarize multiple subscriptions to a single source catalog plan and plan products on PDFs when downloaded.
`salesforceId`	String	The Salesforce ID of the invoice in Salesforce that this object maps to. This is for the Salesforce plugin.
`id`	Integer	The Fusebill generated ID uniquely identifies the invoice.
`uri`	String	The full string path to this resource

Tax Object

Property	Type	Description
`name`	String	The name of the tax
`registrationCode`	String	The tax registration code
`percent`	Decimal	The percent of the tax
`total`	Decimal	The amount of tax determined by combining the `percent` with the taxable amount

Payment Schedule Object

Property	Type	Description
`dueDateTimestamp`	Timestamp	The timestamp of when this payment schedule is due
`status`	Enum:{Due, Overdue, Paid, WrittenOff, Disputed, Void}	The status of this payment schedule
`amount`	Decimal	The amount of the invoice that must be paid as part of this payment schedule
`outstandingBalance`	Decimal	The amount of this payment schedule that still needs to be paid
`daysDueAfterTerm`	Integer	The number of days after the term that this payment schedule is due

Invoice Revisions

Property	Type	Description
`user`	String	The ID of the user who made the revision
`poNumber`	String	The value of the PO number at the time of revision. The value this revision set PO number to is either the PO number on the invoice (if this was the most recent revision), or the PO number of the next revision.
`notes`	String	The value of the notes at the time of revision. The value this revision set notes to is either the notes on the invoice (if this was the most recent revision), or the notes of the next revision.
`reason`	String	The reason given by the user for this revision
`created`	Timestamp	The time this revision was created.
`id`	Number	The Fusebill generated ID which uniquely identifies this revision