website logo
Product Overview
NetSuite
Payments
QuickBooks
Xero
Navigate through spaces
⌘K
Guided Wizard
Guided Wizard Settings
Bill Configuration
Custom Guided Wizard
Button URL Structure
Button URL Generator
Support
Global API
API Overview
Request
Response
Code Examples
Technical Resources
Breadwinner Setup
Requirements
ERD / Object Structure
Getting Help
Version History
Docs powered by archbee 

Invoice

16min

When requesting an Invoice, use the requestJSON to pass the Invoice data, and the response will have responseJSON which stores the Invoices response returned by QuickBooks.

The Invoice object has the following parameters.

Invoice

Field Name

Data Type

Description

Balance

Decimal

The balance reflecting any payments made against the transaction. Read Only

BillAddr

Common Data Types

Identifies the e-mail address where the invoice is sent.

BillEmail

BillEmailClass

Identifies the e-mail address where the invoice is sent

ClassRef

Common Data Types

Reference to the Class associated with the transaction

CurrencyRef

Common Data Types

Reference to the currency in which all amounts on the associated transaction are expressed.

CustomerMemo

Common Data Types

User-entered message to the customer; this message is visible to end user on their transactions

CustomerRef*

Common Data Types

The ID (Unique QuickBooks Online ID) for the referenced customer/vendor

CustomField

CustomFieldDetails

One of, up to three custom fields for the transaction. Available for custom fields so configured for the company

DepartmentRef

Common Data Types

A reference to a Department object specifying the location of the transaction

Deposit

Decimal

Enter the deposit amount

DepositToAccountRef

Common Data Types

Account to which money is deposited

DiscountLineDetail

DiscountDetails

Discount detail type for the entire transaction

DocNumber*

String

Invoice/Bill number

DueDate

String

Date when the payment of the transaction is due. (add by converting date to string)

EmailStatus

String

Email status of the invoice. Valid values: NotSet, NeedToSend, EmailSent

ExchangeRate

Decimal

The number of home currency units it takes to equal one unit of currency specified by CurrencyRef

GlobalTaxCalculation

String

Fixed values (NotApplicable, TaxInclusive)

HomeBalance

Decimal

Read Only

Line*

LineItem

Individual line items of a transaction

Id

String

Unique identifier for this object and ReadOnly field

Metadata

Common Data Types

Descriptive information about the object. The MetaData values are set by Data Services and are read only

Mobile

Common Data Types

Mobile phone number

MobileNumber

String

Mobile Number of contact/vendor

PrivateNote

String

User entered, organization-private note about the transaction

Salesforce_Account_Id

String

To map Invoice with Salesforce Account

Salesforce_Opportunity_Id

String

To map Invoice with Salesforce Opportunity.

ShipAddr

Common Data Types

Identifies the address where the goods must be shipped

ShipDate

String

Date for delivery of goods or services.

ShipMethodRef

Common Data Types

Reference to the ShipMethod associated with the transaction

SalesTermRef

Common Data Types

Reference to a SalesTerm associated with this Customer object

SyncToken

String

Version number of the object. It is used to lock an object for use by one app at a time. Read Only

TotalAmt

Decimal

Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Read Only

TrackingNum

String

Shipping provider’s tracking number for the delivery of the goods associated with the transaction

TxnDate

String

The date entered by the user when this transaction occurred. (add by converting date to string in yyyy-mm-dd format)

TxnTaxDetail

TxnTaxDetail

This data type provides information for taxes charged on the transaction as a whole.

BillEmailClass

Field Name

Data Type

Description

Address

String



CustomFieldDetails 

Field Name

Data Type

Description

DefinitionId

String



Name

String



Type

String



StringValue

String



DiscountDetails

Field Name

Data Type

Description

DiscountAccountRef

Common Data Types



DiscountPercent

Decimal



PercentBased

Boolean



LineItem

Field Name

Data Type

Description

AccountBasedExpenseLineDetail

AccountBasedExpenseLineDetail



Amount

Decimal



Description

String



DetailType

String

Provide the DetailType as SalesItemDetail, DiscountLineDetail, etc.

For Shipping charge apply the DetailType as 'SalesItemLineDetail'

DiscountLineDetail

DiscountLineDetail



Id

String



ItemBasedExpenseLineDetail

ItemBasedExpenseLineDetail



LineNum

Integer



SalesItemLineDetail

SalesItemLineDetail



TaxInclusiveAmt

Decimal



AccountBasedExpenseLineDetail

Field Name

Data Type

Description

AccountRef

Common Data Types



BillableStatus

String



ClassRef

Common Data Types



CustomerRef

Common Data Types



ItemRef

Common Data Types



MarkupInfo

MarkInformation



Qty

Decimal



ServiceDate

String



TaxAmount

Decimal



TaxInclusiveAmt

Decimal



UnitPrice

Decimal



MarkInformation

Field Name

Data Type

Description

Percent

Decimal



DiscountLineDetail

Field Name

Data Type

Description

DiscountAccountRef

Common Data Types



DiscountPercent

Decimal



PercentBased

Boolean



ItemBasedExpenseLineDetail

Field Name

Data Type

Description

BillableStatus

String



ClassRef

Common Data Types



CustomerRef

Common Data Types



ItemRef

Common Data Types



MarkupInfo

MarkInformation



Qty

Decimal



ReceivedQuantity

Decimal



ServiceDate

String



TaxAmount

Decimal



TaxInclusiveAmt

Decimal



UnitPrice

Decimal



SalesItemLineDetail

Field Name

Data Type

Description

ClassRef

Common Data Types



ItemRef

Common Data Types

The ID (Unique QuickBooks Online ID) for the referenced Item.

To apply the shipping charge use the static value of the shipping item: SHIPPING_ITEM_ID

Qty

Decimal



ServiceDate

String



TaxCodeRef

Common Data Types



UnitPrice

Decimal



TxnTaxDetail

Field Name

Data Type

Description

TaxLine

TaxLine[]



TotalTax

Decimal



TxnTaxCodeRef

Common Data Types





Updated 12 May 2023
Did this page help you?
Yes
No
PREVIOUS
Update
NEXT
Read
Docs powered by archbee 
TABLE OF CONTENTS
Invoice
BillEmailClass
CustomFieldDetails 
DiscountDetails
LineItem
AccountBasedExpenseLineDetail
MarkInformation
DiscountLineDetail
ItemBasedExpenseLineDetail
SalesItemLineDetail
TxnTaxDetail