The draft invoice resource represents a future invoice. It contains identifying information on the customer, information on the billing period, the total amount of pending charges, and information on the scheduled charge date.
Property
Type
Description
billingPeriodId
Integer
The Fusebill generated ID that uniquely identifies the billing period
effectiveTimestamp
DateTime
The effective timestamp for when the invoice posts
modifiedTimestamp
DateTime
The timestamp of when this resource was last modified
status
Enum: {Ready, Pending, Projected}
The status of the draft invoice. Only a ready draft invoice can be posted
poNumber
String
The standing PO number. Note that this is only populated if the draft invoice PO number has been overridden. [Max Length: 255 characters]
draftCharges
List of objects. See Invoice and Statements: Charge Object for details
A list of draft charges. This preview contains most of the same information as a charge.
subtotal
Decimal
The subtotal of the invoice before taxes or discounts
totalDiscount
Decimal
The sum of the applied discounts
total
Decimal
The total amount of the draft invoice once taxes have been accounted for. The pending charges
taxes
List of Objects. Defined below
The taxes on this invoice
paymentSchedules
List of Objects. Defined below
Invoices can be set to be paid in installments. If this is the case, this list will dictate the schedule on the posted invoice.
customer
Object. See Customers: Customer Object for details
A snapshot of the customer. Contains a slightly summarized version of the customer object.
notes
String
Billing agents can write notes on draft invoices. Once posted the note is final. [Max Length: 500 characters]
shippingInstructions
String
This free text field allows you to add shipping instructions such as "Bring to Loading Bay #7". [Max Length: 1000 characters]
customerReferenceValue
String
The reference value of the customer. Intended to be your internal ID for the customer
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 will be used to determine the due date instead of terms
lastGenerated
String
A string describing how long ago the draft invoice was generated
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.
id
Integer
The Fusebill generated ID that uniquely identifies this draft 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
amount
Decimal
The amount of the invoice that must be paid as part of this payment schedule. For when the invoice posts
daysDueAfterTerm
Integer
The number of days after the term that this payment schedule is due. For when the invoice posts
