Invoice
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 | 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 | Reference to the Class associated with the transaction |
CurrencyRef | value_name | Reference to the currency in which all amounts on the associated transaction are expressed. |
CustomerMemo | CustomerMemo | User-entered message to the customer; this message is visible to end user on their transactions |
CustomerRef* | value_name | The ID (Unique QuickBooks Online ID) for the referenced customer/vendor |
CustomField | CustomerFieldDetails | One of, up to three custom fields for the transaction. Available for custom fields so configured for the company |
DepartmentRef | value_name | A reference to a Department object specifying the location of the transaction |
Deposit | Decimal | Enter the deposit amount |
DepositToAccountRef | value_name | Account to which money is deposited |
DiscountLineDetail | DiscountDetails | 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 | Individual line items of a transaction |
Id | String | Unique identifier for this object and ReadOnly field |
Metadata | Metadata | Descriptive information about the object. The MetaData values are set by Data Services and are read only |
Mobile | PhoneWrapper | 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 | Identifies the address where the goods must be shipped |
ShipDate | String | Date for delivery of goods or services. |
ShipMethodRef | value_name | Reference to the ShipMethod associated with the transaction |
SalesTermRef | value_name | 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 |
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 |  |
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 |  |
GroupLineDetail | GroupLineDetail | |
Id | String |  |
ItemBasedExpenseLineDetail | ItemBasedExpendeLineDetail |  |
LineNum | Integer |  |
SalesItemLineDetail | SalesItemLineDetail |  |
TaxInclusiveAmt | Decimal |  |
AccountBasedExpenseLineDetail
Field Name | Data Type | Description |
|---|---|---|
AccountRef | value_name |  |
BillableStatus | String |  |
ClassRef | value_name |  |
CustomerRef | value_name |  |
ItemRef | value_name |  |
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 | value_name |  |
DiscountPercent | Decimal |  |
PercentBased | Boolean |  |
GroupLineDetail
Field Name | Data Type | Description |
|---|---|---|
Amount | Decimal |  |
Line | List<LineItem> |  |
Quantity | Integer |  |
GroupItemRef | value_name |  |
ItemBasedExpenseLineDetail
Field Name | Data Type | Description |
|---|---|---|
BillableStatus | String |  |
ClassRef | value_name |  |
CustomerRef | value_name |  |
ItemRef | value_name |  |
MarkupInfo | MarkInformation |  |
Qty | Decimal |  |
ReceivedQuantity | Decimal |  |
ServiceDate | String |  |
TaxAmount | Decimal |  |
TaxInclusiveAmt | Decimal |  |
UnitPrice | Decimal |  |
SalesItemLineDetail
Field Name | Data Type | Description |
|---|---|---|
ClassRef | value_name |  |
ItemRef | value_name | 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 |  |
UnitPrice | Decimal |  |
TxnTaxDetail
Field Name | Data Type | Description |
|---|---|---|
TaxLine | TaxLine[] |  |
TotalTax | Decimal |  |
TxnTaxCodeRef | value_name |  |
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. |