--- title: Invoice slug: quickbooks/gEE1-invoice description: Learn about the parameters of the Invoice object in QuickBooks with this comprehensive document. Discover crucial details including balance, billing address, email status, currency reference, customer reference, custom fields, sales and tax information, a docTags: createdAt: 2021-10-29T11:14:38.000Z --- When processing an Invoice, use the requestJSON to pass the Invoice data. The returned response will contain a responseJSON section with the Invoice response returned by Breadwinner for QuickBooks. The Invoice object has the following parameters. ### Invoice | **Field Name** | **Data Type** | **Description** | | ----------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | Balance | Decimal | The balance reflects any payments made against the transaction. Read Only | | BillAddr | [AddressWrapper](docId\:GoAsZtQI8wCZGotEKYtEK) | Identifies the e-mail address where the invoice is sent. | | BillEmail | BillEmailClass | Identifies the e-mail address where the invoice is sent | | ClassRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | Reference to the Class associated with the transaction | | CurrencyRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | Reference to the currency in which all amounts on the associated transaction are expressed. | | CustomerMemo | [CustomerMemo](docId\:gEE1Fj42aMxfapEUMYyQi) | User-entered message to the customer; this message is visible to end user on their transactions | | CustomerRef* | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | The ID (Unique QuickBooks Online ID) for the referenced customer/vendor | | CustomField | [CustomerFieldDetails](docId\:gEE1Fj42aMxfapEUMYyQi) | One of, up to three custom fields for the transaction. Available for custom fields so configured for the company | | DepartmentRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | A reference to a Department object specifying the location of the transaction | | Deposit | Decimal | Enter the deposit amount | | DepositToAccountRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | Account to which money is deposited | | DiscountLineDetail | ****[DiscountDetails](docId\:gEE1Fj42aMxfapEUMYyQi) | Discount detail type for the entire transaction | | DocNumber* | String | Invoice 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](docId\:gEE1Fj42aMxfapEUMYyQi) | Individual line items of a transaction | | Id | String | Unique identifier for this object and ReadOnly field | | Metadata | [Metadata](docId\:GoAsZtQI8wCZGotEKYtEK) | Descriptive information about the object. The MetaData values are set by Data Services and are read only | | Mobile | [PhoneWrapper](docId\:GoAsZtQI8wCZGotEKYtEK) | 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 | [AddressWrapper](docId\:GoAsZtQI8wCZGotEKYtEK) | Identifies the address where the goods must be shipped | | ShipDate | String | Date for delivery of goods or services. | | ShipMethodRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | Reference to the ShipMethod associated with the transaction | | SalesTermRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | Reference to a SalesTerm associated with this Customer object | | Sparse | Boolean | Allows updating only specified properties of an object while leaving unspecified properties unchanged. | | 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 | **** | This data type provides information for taxes charged on the transaction as a whole. | | SendInvoice | Boolean | To email the invoice with its creation, set the parameter to true. [CreateandSendInvoice](https://docs.breadwinner.com/quickbooks/create-and-send-invoice) | ### 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 | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | DiscountPercent | Decimal | | | PercentBased | Boolean | | ### LineItem | **Field Name** | **Data Type** | **Description** | | ----------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | AccountBasedExpenseLineDetail | ****[AccountBasedExpenseLineDetail](docId\:gEE1Fj42aMxfapEUMYyQi) | | | Amount | Decimal | | | Description | String | | | DetailType | String | Provide the DetailType as SalesItemDetail, DiscountLineDetail, etc.
For Shipping charge apply the DetailType as 'SalesItemLineDetail' | | DiscountLineDetail | ****[DiscountLineDetail](docId\:gEE1Fj42aMxfapEUMYyQi) | | | GroupLineDetail | [GroupLineDetail](docId\:gEE1Fj42aMxfapEUMYyQi) | | | Id | String | | | ItemBasedExpenseLineDetail | ****[ItemBasedExpendeLineDetail](docId\:gEE1Fj42aMxfapEUMYyQi) | | | LineNum | Integer | | | SalesItemLineDetail | [SalesItemLineDetail](docId\:gEE1Fj42aMxfapEUMYyQi) | | | TaxInclusiveAmt | Decimal | | ### AccountBasedExpenseLineDetail | **Field Name** | **Data Type** | **Description** | | --------------- | --------------------------------------------------- | --------------- | | AccountRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | BillableStatus | String | | | ClassRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | CustomerRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | ItemRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | MarkupInfo | ****[MarkInformation](docId\:gEE1Fj42aMxfapEUMYyQi) | | | 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 | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | DiscountPercent | Decimal | | | PercentBased | Boolean | ### | ### GroupLineDetail | **Field Name** | **Data Type** | **Description** | | -------------- | ----------------------------------------------- | --------------- | | Amount | Decimal | | | Line | List\<[LineItem](docId\:gEE1Fj42aMxfapEUMYyQi)> | | | Quantity | Integer | | | GroupItemRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | ### ItemBasedExpenseLineDetail | **Field Name** | **Data Type** | **Description** | | ---------------- | --------------------------------------------------- | --------------- | | BillableStatus | String | | | ClassRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | CustomerRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | ItemRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | MarkupInfo | ****[MarkInformation](docId\:gEE1Fj42aMxfapEUMYyQi) | | | Qty | Decimal | | | ReceivedQuantity | Decimal | | | ServiceDate | String | | | TaxAmount | Decimal | | | TaxInclusiveAmt | Decimal | | | UnitPrice | Decimal | | ### SalesItemLineDetail | **Field Name** | **Data Type** | **Description** | | -------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ClassRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | ItemRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | 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. This is only valid when
Preferences.SalesFormsPrefs.AllowShipping is set to true. | | Qty | Decimal | | | ServiceDate | String | | | TaxCodeRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | | UnitPrice | Decimal | | ### TxnTaxDetail | **Field Name** | **Data Type** | **Description** | | -------------- | ------------------------------------------- | --------------- | | TaxLine | TaxLine\[] | | | TotalTax | Decimal | | | TxnTaxCodeRef | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) | | ### CustomerMemo | **Field Name** | **Data Type** | **Description** | | -------------- | -------------- | ---------------------------------------------------------------------------------------------------- | | value | String | User-entered message to the customer; this message is visible to the end user on their transactions. |