Invoice

An invoice [Invoice] is a collection of charges [Slip] for goods and services rendered that you issue to request an amount payable from a customer.

Review the Usage Guidelines for the Invoice object.

—	XML	SOAP	REST	Database table
Object	Invoice	oaInvoice	—	invoice
Supported Commands	Add, Read, Modify, ModifyOnCondition, Delete, Submit, Approve, Reject, Unapprove	add(), read(), modify(), upsert(), delete(), submit(), approve(), reject(), unapprove()	—	—

The Invoice object has the following standard properties:

Note:

Invoice object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	Database	Description
access_log	access_log	The mailing and access history of the invoice, such as when the customer accessed it.
accounting	accounting	A 1/0 field indicating if an invoice has been sent to an accounting partner.
acct_date	acct_date	The accounting period date of the invoice. See Date Fields.
approval_status	approval_status	A one-character string indicating the approval status of the invoice. Only used if invoice approvals are used. Possible values: O - Open S - Submitted A - Approved R - Rejected
approved	date_approved	Date the invoice was approved. See Date Fields.
attachmentid	attachment_id	The ID of the associated attachment.
balance	balance	[Read-only] The outstanding balance on the invoice. Dated by the date field.
contactid	contact_id	The contact ID for this invoice.
created	created	[Read-only] Time the record was created. See Date Fields.
credit	credit	The amount of any credit against the invoice. Dated by the date field.
credit_reason	credit_reason	The reason for the credit.
credit_rebill_status	credit_rebill_status	Credit/Rebill status for the original invoice: C = Credit Initiated and R = Re-Bill.
currency	currency	The currency this invoice is in.
customerid	customer_id	[Required] The ID of the associated customer.
date	date	[Required] The date of the invoice. See Date Fields.
draw	draw	The amount of any draw against retainer for this invoice. Dated by the draw_date field.
draw_date	draw_date	The date of the draw. See Date Fields.
emailed	date_emailed	Date the user emailed the invoice. For invoices created before this field existed, this field is set to 1970-01-01 to flag it as an unknown value. See Date Fields.
externalid	external_id	If the record was imported from an external system, you store the unique external record ID here.
id	id	[Read-only] Unique ID. Automatically assigned by OpenAir.
invoice_layoutid	invoice_layoutid	The ID of the associated invoice layout.
notes	notes	Notes associated with the invoice.
number	number	The invoice number. Must be unique
original_invoiceid	original_invoiceid	The original invoice ID for credit invoices.
paperrequest	paper_requested	Date the user requested that a paper invoice be mailed. See Date Fields.
papersend	paper_sent	Date the paper invoice was actually mailed. See Date Fields.
payment_termsid	payment_terms_id	The ID of the associated payment terms. Requires the Save Payment Terms Internal ID on Invoice Records optional feature to be enabled for the OpenAir account. The field is empty otherwise. See Save Payment Terms Internal ID on Invoice Records. Either terms or payment_termsid is required. If both are passed they must match the same payment terms.
shipping_contactid	shipping_contact_id	The shipping contact ID for this invoice.
status	status	The status of the invoice (EZ Invoice, emailed Invoice) 0 => Unknown, 1 => Not Sent, 2 => Viewed, 3 => EZ Requested, 4=> Rejected,5 => Sent, 6 => EZ Sent, 7 => Retracted
submitted	date_submitted	[Read-only] Date the invoice was submitted. See Date Fields.
tax	tax	[Read-only] The tax total for the invoice. Dated by the date field.
tax_federal	tax_federal	[Read-only] The federal tax total for the invoice. Dated by the date field.
tax_gst	tax_gst	[Read-only] The GST tax for the invoice. Dated by the date field.
tax_hst	tax_hst	[Read-only] The HST tax for the invoice. Dated by the date field.
tax_pst	tax_pst	[Read-only] The PST tax for the invoice. Dated by the date field.
tax_state	tax_state	[Read-only] The state tax total for the invoice. Dated by the date field.
terms	terms	Payment terms for this invoice. Required unless payment_termsid is passed and the Save Payment Terms Internal ID on Invoice Records optional feature to be enabled for the OpenAir account.
total	total	[Read-only] The invoice total. Dated by the date field.
updated	updated	[Read-only] Time the record was updated. See Date Fields.

Usage Guidelines

Your company's account can be configured to allow using the API to modify approved invoices. To enable the feature, contact OpenAir Customer Support.