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

invoiceNumberIntegerThe invoice number as shown to the customer
invoiceSignatureStringThe signature, with formatting, that appears on the invoice when viewed as PDF or HTML.
poNumberStringThe standing PO number
effectiveTimestampDateTimeThe effective timestamp of the invoice
postedTimestampDateTimeThe timestamp of when the invoice was posted
modifiedTimestampDateTimeThe timestamp for when the invoice was last modified
chargesList of Objects. See Invoices And Statements: ChargesThe charges associated with this invoice
subtotalDecimalThe subtotal of the invoice
invoiceAmountDecimalThe amount being invoiced
totalPaymentsDecimalThe sum of the payments made so far
unsettledBooleanIf using the Fusebill Payments gateway, then this is true if any payment note has a pending settlement status
outstandingBalanceDecimalThe sum of the amounts still owing
termsEnum:{Net0, Net5, Net7, Net10, Net15, Net21, Net30, Net45, Net60, Net75, Net90, MFI1, DayOfMonth1, DayOfMonth2, DayOfMonth3, ... DayOfMonth29, DayOfMonth30, DayOfMonth31}The billing term for this invoice.
defaultTermsEnum:{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.
isDefaultTermsBooleanIf true, then defaultTerms is being used to determine the due date instead of terms
customerIdIntegerThe Fusebill generated ID that uniquely identifies the customer
invoiceCustomerObjectA 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
invoiceCustomerAddressPreferenceObject. See Customer: Customer Address Preference for detailsThe address preference of the customer.
sumOfCreditNotesDecimalThe sum of the credit notes for this invoice
totalWriteoffsDecimalThe sum of the write offs for this invoice
taxesA list of Objects. Defined belowThe taxes on this invoice
totalDiscountDecimalThe sum of the discounts applied on this invoice
paymentSchedulesA list of Objects. Defined belowThe invoice can be set to be paid in installments. If this is the case, this list dictates the schedule.
notesStringBilling agents can write notes on draft invoices. Once posted the note is final. [Max Length: 500 characters]
customerReferenceValueStringThe reference value of the customer. Intended to be your internal ID for the customer
openingArBalanceDecimalThe opening balance of accounts receivable at invoice post
closingArBalanceDecimalThe closing balance of accounts receivable at invoice post
invoiceInMemoryOnlyBooleanFor internal use
invoiceRevisionsList of objects. Defined below.A list of changes made to the invoice after it was posted
totalTaxesDecimalThe summation of the applied taxes
rollUpPdfBooleanIs 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.
salesforceIdStringThe Salesforce ID of the invoice in Salesforce that this object maps to. This is for the Salesforce plugin.
idIntegerThe Fusebill generated ID uniquely identifies the invoice.
uriStringThe full string path to this resource

Tax Object

nameStringThe name of the tax
registrationCodeStringThe tax registration code
percentDecimalThe percent of the tax
totalDecimalThe amount of tax determined by combining the percent with the taxable amount

Payment Schedule Object

dueDateTimestampTimestampThe timestamp of when this payment schedule is due
statusEnum:{Due, Overdue, Paid, WrittenOff, Disputed, Void}The status of this payment schedule
amountDecimalThe amount of the invoice that must be paid as part of this payment schedule
outstandingBalanceDecimalThe amount of this payment schedule that still needs to be paid
daysDueAfterTermIntegerThe number of days after the term that this payment schedule is due

Invoice Revisions

userStringThe ID of the user who made the revision
poNumberStringThe 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.
notesStringThe 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.
reasonStringThe reason given by the user for this revision
createdTimestampThe time this revision was created.
idNumberThe Fusebill generated ID which uniquely identifies this revision