QuickBooks: Sample batch request — request body — body Batch Item Request item

Sample batch request: request body, field body / BatchItemRequest / item. Complete fields and constraints for contract 2026-10-20.

API reference · Contract 2026-10-20

SDK schema: Sample batch request — request body — body Batch Item Request item

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 1).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 1).Query`	string	Required within parent	Minimum length: 1
`$ (anyOf 2)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 2).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 2).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 2).Account`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 2).Account.AccountSubType`	string	Optional	The account sub-type classification and is based on the AccountType value. Required if AccountType is not specified. Conditionally required
`$ (anyOf 2).Account.AccountType`	string	Optional	A detailed account classification that specifies the use of this account. The type is based on the Classification. Required if AccountSubType is not specified. Conditionally required
`$ (anyOf 2).Account.AcctNum`	string	Optional	User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. The Account.AcctNum attribute must not contain colon (:). Conditionally required
`$ (anyOf 2).Account.Active`	JSON	Optional	Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
`$ (anyOf 2).Account.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 2).Account.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 2).Account.Classification`	string	Optional	The classification of an account. Not supported for non-posting accounts. Valid values include: Asset , Equity , Expense , Liability , Revenue Read only: true
`$ (anyOf 2).Account.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which this account holds amounts. Read only: true
`$ (anyOf 2).Account.CurrentBalance`	JSON	Optional	Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. Decimal string Read only: true
`$ (anyOf 2).Account.CurrentBalance (anyOf 1)`	number	Alternative
`$ (anyOf 2).Account.CurrentBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 2).Account.CurrentBalanceWithSubAccounts`	JSON	Optional	Specifies the cumulative balance amount for the current Account and all its sub-accounts. Decimal string Read only: true
`$ (anyOf 2).Account.CurrentBalanceWithSubAccounts (anyOf 1)`	number	Alternative
`$ (anyOf 2).Account.CurrentBalanceWithSubAccounts (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 2).Account.Description`	string	Optional	User entered description for the account, which may include user entered information to guide bookkeepers/accountants in deciding what journal entries to post to the account.
`$ (anyOf 2).Account.FullyQualifiedName`	string	Optional	Fully qualified name of the object; derived from Name and ParentRef . The fully qualified name prepends the topmost parent, followed by each subaccount separated by colons and takes the form of Parent:Account1:SubAccount1:SubAccount2 . System generated. Limited to 5 levels. Read only: true
`$ (anyOf 2).Account.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 2).Account.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 2).Account.Name`	string	Required within parent	User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:).
`$ (anyOf 2).Account.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the Parent AccountId if this represents a SubAccount.
`$ (anyOf 2).Account.SubAccount`	JSON	Optional	Specifies whether this object represents a parent (false) or subaccount (true). Please note that accounts of these types - OpeningBalanceEquity , UndepositedFunds , RetainedEarnings , CashReceiptIncome , CashExpenditureExpense , ExchangeGainOrLoss cannot have a sub account and cannot be a sub account of another account. Read only: true
`$ (anyOf 2).Account.SubAccount (anyOf 1)`	boolean	Alternative
`$ (anyOf 2).Account.SubAccount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 2).Account.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 2).Account.TaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the default tax code used by this account. Tax codes are referenced by the TaxCode.Id in the TaxCode object. For global locales, only. Conditionally required
`$ (anyOf 2).Account.domain`	string	Optional
`$ (anyOf 2).Account.sparse`	boolean	Optional
`$ (anyOf 3)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 3).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 3).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 3).Account`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 3).Account.AccountSubType`	string	Optional	The account sub-type classification and is based on the AccountType value.
`$ (anyOf 3).Account.AccountType`	string	Optional	A detailed account classification that specifies the use of this account. The type is based on the Classification.
`$ (anyOf 3).Account.AcctNum`	string	Optional	User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. The Account.AcctNum attribute must not contain colon (:). Name must be unique. Max length for Account.AcctNum : AU & CA: 20 characters. US, UK & IN: 7 characters Conditionally required
`$ (anyOf 3).Account.Active`	JSON	Optional	Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
`$ (anyOf 3).Account.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 3).Account.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 3).Account.Classification`	string	Optional	The classification of an account. Not supported for non-posting accounts. Valid values include: Asset , Equity , Expense , Liability , Revenue Read only: true
`$ (anyOf 3).Account.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which this account holds amounts. Read only: true
`$ (anyOf 3).Account.CurrentBalance`	JSON	Optional	Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. Decimal string Read only: true
`$ (anyOf 3).Account.CurrentBalance (anyOf 1)`	number	Alternative
`$ (anyOf 3).Account.CurrentBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 3).Account.CurrentBalanceWithSubAccounts`	JSON	Optional	Specifies the cumulative balance amount for the current Account and all its sub-accounts. Decimal string Read only: true
`$ (anyOf 3).Account.CurrentBalanceWithSubAccounts (anyOf 1)`	number	Alternative
`$ (anyOf 3).Account.CurrentBalanceWithSubAccounts (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 3).Account.Description`	string	Optional	User entered description for the account, which may include user entered information to guide bookkeepers/accountants in deciding what journal entries to post to the account.
`$ (anyOf 3).Account.FullyQualifiedName`	string	Optional	Fully qualified name of the object; derived from Name and ParentRef . The fully qualified name prepends the topmost parent, followed by each subaccount separated by colons and takes the form of Parent:Account1:SubAccount1:SubAccount2 . System generated. Limited to 5 levels. Read only: true
`$ (anyOf 3).Account.Id`	string	Required within parent
`$ (anyOf 3).Account.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 3).Account.Name`	string	Optional	User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:).
`$ (anyOf 3).Account.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the Parent AccountId if this represents a SubAccount.
`$ (anyOf 3).Account.SubAccount`	JSON	Optional	Specifies whether this object represents a parent (false) or subaccount (true). Please note that accounts of these types - OpeningBalanceEquity , UndepositedFunds , RetainedEarnings , CashReceiptIncome , CashExpenditureExpense , ExchangeGainOrLoss cannot have a sub account and cannot be a sub account of another account. Read only: true
`$ (anyOf 3).Account.SubAccount (anyOf 1)`	boolean	Alternative
`$ (anyOf 3).Account.SubAccount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 3).Account.SyncToken`	string	Required within parent
`$ (anyOf 3).Account.TaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the default tax code used by this account. Tax codes are referenced by the TaxCode.Id in the TaxCode object. For global locales, only.
`$ (anyOf 3).Account.domain`	string	Optional
`$ (anyOf 3).Account.sparse`	boolean	Optional
`$ (anyOf 4)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 4).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 4).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 4).Attachable`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 4).Attachable.AttachableRef`	array	Optional	Specifies the transaction object to which this attachable file is to be linked.
`$ (anyOf 4).Attachable.AttachableRef[]`	Model	Each item	Expand Delete an attachable — request body — body Attachable Ref item
`$ (anyOf 4).Attachable.Category`	string	Optional	Category of the attachment. Valid values include (case sensitive): Contact Photo , Document , Image , Receipt , Signature , Sound , Other .
`$ (anyOf 4).Attachable.ContentType`	string	Optional	ContentType of the attachment. Returned for file attachments.
`$ (anyOf 4).Attachable.FileAccessUri`	string	Optional	FullPath FileAccess URI of the attachment. Returned for file attachments. Read only: true
`$ (anyOf 4).Attachable.FileName`	string	Optional	FileName of the attachment. Required for file attachments. Conditionally required
`$ (anyOf 4).Attachable.Id`	string	Optional	Unique Identifier for an Intuit entity (object). Required for the update operation. Read only: true
`$ (anyOf 4).Attachable.Lat`	string	Optional	Latitude from where the attachment was requested.
`$ (anyOf 4).Attachable.Long`	string	Optional	Longitude from where the attachment was requested.
`$ (anyOf 4).Attachable.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 4).Attachable.Note`	string	Optional	The note is either related to the attachment specified with the FileName attribute, or as a standalone note. Required for note attachments. Conditionally required
`$ (anyOf 4).Attachable.PlaceName`	string	Optional	PlaceName from where the attachment was requested.
`$ (anyOf 4).Attachable.Size`	JSON	Optional	Size of the attachment. Returned for file attachments. Decimal string Read only: true
`$ (anyOf 4).Attachable.Size (anyOf 1)`	number	Alternative
`$ (anyOf 4).Attachable.Size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 4).Attachable.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 4).Attachable.Tag`	string	Optional	Tag name for the requested attachment.
`$ (anyOf 4).Attachable.TempDownloadUri`	string	Optional	TempDownload URI which can be directly downloaded by clients. Returned for file attachments. Read only: true
`$ (anyOf 4).Attachable.ThumbnailFileAccessUri`	string	Optional	FullPath FileAccess URI of the attachment thumbnail if the attachment file is of a content type with thumbnail support. Returned for file attachments. Read only: true
`$ (anyOf 4).Attachable.ThumbnailTempDownloadUri`	string	Optional	Thumbnail TempDownload URI which can be directly downloaded by clients. This is only available if the attachment file is of a content type with thumbnail support. Returned for file attachments. Read only: true
`$ (anyOf 4).Attachable.domain`	string	Optional
`$ (anyOf 4).Attachable.sparse`	boolean	Optional
`$ (anyOf 5)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 5).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 5).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 5).Attachable`	Model	Required within parent	Expand Delete an attachable — request body — body
`$ (anyOf 6)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 6).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 6).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 6).Attachable`	Model	Required within parent	Expand Delete an attachable — request body — body
`$ (anyOf 7)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 7).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 7).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 7).Bill`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 7).Bill.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 7).Bill.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the bill is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 7).Bill.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 7).Bill.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 7).Bill.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 7).Bill.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 7).Bill.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 7).Bill.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 7).Bill.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 7).Bill.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 7).Bill.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 7).Bill.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 7).Bill.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 7).Bill.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 7).Bill.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 7).Bill.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 7).Bill.IncludeInAnnualTPAR`	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 7).Bill.IncludeInAnnualTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 7).Bill.IncludeInAnnualTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 7).Bill.Line`	array	Required within parent	The minimum line item required for the request.
`$ (anyOf 7).Bill.Line[]`	Model	Each item	Expand Create a bill — request body — body Line item
`$ (anyOf 7).Bill.LinkedTxn`	array	Optional	Zero or more transactions linked to this Bill object. The LinkedTxn.TxnType can be set to PurchaseOrder , BillPaymentCheck , or ReimburseCharge . Use LinkedTxn.TxnId as the ID of the transaction.
`$ (anyOf 7).Bill.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 7).Bill.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 7).Bill.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 7).Bill.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Bill was created from. Read only: true
`$ (anyOf 7).Bill.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 7).Bill.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 7).Bill.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 7).Bill.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 7).Bill.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 7).Bill.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 7).Bill.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details of all taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 7).Bill.VendorRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 7).Bill.domain`	string	Optional
`$ (anyOf 7).Bill.sparse`	boolean	Optional
`$ (anyOf 8)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 8).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 8).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 8).Bill`	Model	Required within parent	Expand Delete a bill — request body — body
`$ (anyOf 9)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 9).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 9).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 9).Bill`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 9).Bill.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 9).Bill.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the bill is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 9).Bill.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 9).Bill.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 9).Bill.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 9).Bill.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 9).Bill.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 9).Bill.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 9).Bill.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 9).Bill.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 9).Bill.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 9).Bill.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 9).Bill.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 9).Bill.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 9).Bill.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 9).Bill.Id`	string	Required within parent
`$ (anyOf 9).Bill.IncludeInAnnualTPAR`	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 9).Bill.IncludeInAnnualTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 9).Bill.IncludeInAnnualTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 9).Bill.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: ItemBasedExpenseLine and AccountBasedExpenseLine
`$ (anyOf 9).Bill.Line[]`	JSON	Each item
`$ (anyOf 9).Bill.Line[] (anyOf 1)`	Model	Alternative	Expand Delete a bill — request body — body Line item Amount, Custom Extensions, Description, Detail Type, Id, Item Based Expense Line Detail, Line Num, Linked Txn
`$ (anyOf 9).Bill.Line[] (anyOf 2)`	Model	Alternative	Expand Delete a bill — request body — body Line item Account Based Expense Line Detail, Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Linked Txn
`$ (anyOf 9).Bill.LinkedTxn`	array	Optional	Zero or more transactions linked to this Bill object. The LinkedTxn.TxnType can be set to PurchaseOrder , BillPaymentCheck , or ReimburseCharge . Use LinkedTxn.TxnId as the ID of the transaction.
`$ (anyOf 9).Bill.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 9).Bill.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 9).Bill.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 9).Bill.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Bill was created from. Read only: true
`$ (anyOf 9).Bill.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 9).Bill.SyncToken`	string	Required within parent
`$ (anyOf 9).Bill.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 9).Bill.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 9).Bill.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 9).Bill.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 9).Bill.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details of all taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 9).Bill.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 9).Bill.domain`	string	Optional
`$ (anyOf 9).Bill.sparse`	boolean	Optional
`$ (anyOf 10)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 10).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 10).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 10).BillPayment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 10).BillPayment.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 10).BillPayment.CheckPayment`	Model	Optional	Expand Void a billpayment — request body — body Check Payment Reference to the vendor for this transaction. Required when PayType is Check . Conditionally required
`$ (anyOf 10).BillPayment.CreditCardPayment`	Model	Optional	Expand Void a billpayment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Not applicable to Estimate and SalesOrder. Required when PayType is CreditCard . Conditionally required
`$ (anyOf 10).BillPayment.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 10).BillPayment.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 10).BillPayment.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 10).BillPayment.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 10).BillPayment.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 10).BillPayment.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 10).BillPayment.Id`	string	Optional	Unique Identifier for an Intuit entity (object). Read only: true
`$ (anyOf 10).BillPayment.Line`	array	Required within parent	Individual line items representing zero or more Bill , VendorCredit , and JournalEntry objects linked to this BillPayment object. Valid Line types include: LinkedTxnLine:
`$ (anyOf 10).BillPayment.Line[]`	Model	Each item	Expand Void a payment — request body — body Line item
`$ (anyOf 10).BillPayment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 10).BillPayment.PayType`	string	Required within parent	The payment type. Valid values include: Check , CreditCard
`$ (anyOf 10).BillPayment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the form.
`$ (anyOf 10).BillPayment.ProcessBillPayment`	JSON	Optional	Indicates that the payment should be processed by merchant account service. Valid for QuickBooks companies with credit card processing.
`$ (anyOf 10).BillPayment.ProcessBillPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 10).BillPayment.ProcessBillPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 10).BillPayment.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 10).BillPayment.TotalAmt`	JSON	Required within parent	Indicates the total amount of the associated with this payment. This includes the total of all the payments from the BillPayment Details. Decimal string
`$ (anyOf 10).BillPayment.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 10).BillPayment.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 10).BillPayment.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 10).BillPayment.VendorRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction.
`$ (anyOf 10).BillPayment.domain`	string	Optional
`$ (anyOf 10).BillPayment.sparse`	boolean	Optional
`$ (anyOf 11)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 11).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 11).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 11).BillPayment`	Model	Required within parent	Expand Void a billpayment — request body — body
`$ (anyOf 12)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 12).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 12).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 12).BillPayment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 12).BillPayment.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 12).BillPayment.CheckPayment`	Model	Optional	Expand Void a billpayment — request body — body Check Payment Information about a check payment for the transaction. Not applicable to Estimate and SalesOrder. Used when PayType is Check .
`$ (anyOf 12).BillPayment.CreditCardPayment`	Model	Optional	Expand Void a billpayment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Not applicable to Estimate and SalesOrder. Used when PayType is CreditCard .
`$ (anyOf 12).BillPayment.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here .Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 12).BillPayment.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 12).BillPayment.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 12).BillPayment.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 12).BillPayment.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 12).BillPayment.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 12).BillPayment.Id`	string	Required within parent
`$ (anyOf 12).BillPayment.Line`	array	Optional	Individual line items representing zero or more Bill , VendorCredit , and JournalEntry objects linked to this BillPayment object. Use Line.LinkedTxn.TxnId as the ID in a separate Bill, VendorCredit, or JournalEntry read request to retrieve details of the linked object. LinkedTxnLine:
`$ (anyOf 12).BillPayment.Line[]`	Model	Each item	Expand Void a payment — request body — body Line item
`$ (anyOf 12).BillPayment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 12).BillPayment.PayType`	string	Optional	The payment type. Valid values include: Check , CreditCard
`$ (anyOf 12).BillPayment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the form.
`$ (anyOf 12).BillPayment.ProcessBillPayment`	JSON	Optional	Indicates that the payment should be processed by merchant account service. Valid for QuickBooks companies with credit card processing.
`$ (anyOf 12).BillPayment.ProcessBillPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 12).BillPayment.ProcessBillPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 12).BillPayment.SyncToken`	string	Required within parent
`$ (anyOf 12).BillPayment.TotalAmt`	JSON	Optional	Indicates the total amount associated with this payment. This includes the total of all the payments from the payment line details. If TotalAmt is greater than the total on the lines being paid, the overpayment is treated as a credit and exposed as such on the QuickBooks UI. It cannot be negative. Decimal string
`$ (anyOf 12).BillPayment.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 12).BillPayment.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 12).BillPayment.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 12).BillPayment.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 12).BillPayment.domain`	string	Optional
`$ (anyOf 12).BillPayment.sparse`	boolean	Optional
`$ (anyOf 13)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 13).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 13).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 13).Budget`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 13).Budget.Active`	JSON	Optional	Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
`$ (anyOf 13).Budget.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 13).Budget.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 13).Budget.BudgetDetail`	array	Optional	Container for the budget items.
`$ (anyOf 13).Budget.BudgetDetail[]`	Model	Each item	Expand Create a budget — request body — body Budget Detail item
`$ (anyOf 13).Budget.BudgetEntryType`	string	Optional	Period that this budget detail covers.. Valid values include: Monthly , Quarterly , Annually . Read only: true
`$ (anyOf 13).Budget.BudgetType`	string	Optional	Budget types. The only value currently supported is ProfitAndLoss . Read only: true
`$ (anyOf 13).Budget.CustomExtensions`	Model	Optional	Expand Create an item — request body — body Custom Extensions Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.
`$ (anyOf 13).Budget.EndDate`	string	Required within parent	Budget end date.
`$ (anyOf 13).Budget.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 13).Budget.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 13).Budget.Name`	string	Optional	User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:). Read only: true
`$ (anyOf 13).Budget.StartDate`	string	Required within parent	Budget begin date.
`$ (anyOf 13).Budget.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 13).Budget.domain`	string	Optional
`$ (anyOf 13).Budget.sparse`	boolean	Optional
`$ (anyOf 14)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 14).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 14).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 14).Budget`	Model	Required within parent	Expand Delete a budget — request body — body
`$ (anyOf 15)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 15).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 15).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 15).Budget`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 15).Budget.Active`	JSON	Optional	Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
`$ (anyOf 15).Budget.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 15).Budget.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 15).Budget.BudgetDetail`	array	Optional	Container for the budget items.
`$ (anyOf 15).Budget.BudgetDetail[]`	Model	Each item	Expand Create a budget — request body — body Budget Detail item
`$ (anyOf 15).Budget.BudgetEntryType`	string	Optional	Period that this budget detail covers.. Valid values include: Monthly , Quarterly , Annually . Read only: true
`$ (anyOf 15).Budget.BudgetType`	string	Optional	Budget types. The only value currently supported is ProfitAndLoss . Read only: true
`$ (anyOf 15).Budget.CustomExtensions`	Model	Optional	Expand Create an item — request body — body Custom Extensions Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.
`$ (anyOf 15).Budget.EndDate`	string	Optional	Budget end date.
`$ (anyOf 15).Budget.Id`	string	Required within parent
`$ (anyOf 15).Budget.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 15).Budget.Name`	string	Optional	User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:). Read only: true
`$ (anyOf 15).Budget.StartDate`	string	Optional	Budget begin date.
`$ (anyOf 15).Budget.SyncToken`	string	Required within parent
`$ (anyOf 15).Budget.domain`	string	Optional
`$ (anyOf 15).Budget.sparse`	boolean	Optional
`$ (anyOf 16)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 16).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 16).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 16).ChangeOrder`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 16).ChangeOrder.AcceptedBy`	string	Optional	Name of the customer or representative who accepted the change order. Populated when TxnStatus is set to Accepted .
`$ (anyOf 16).ChangeOrder.AcceptedDate`	string	Optional	Date the change order was accepted. Populated when TxnStatus is set to Accepted .
`$ (anyOf 16).ChangeOrder.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, sales tax is calculated first and then any discount is applied. If true , the discount is subtracted first and then sales tax is calculated.
`$ (anyOf 16).ChangeOrder.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 16).ChangeOrder.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 16).ChangeOrder.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Email address where the change order is sent. Required when EmailStatus is set to NeedToSend . Conditionally required
`$ (anyOf 16).ChangeOrder.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; visible on the Change Order document sent to the customer.
`$ (anyOf 16).ChangeOrder.CustomerRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to the customer associated with this change order. Must match the customer on the parent project estimate. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 16).ChangeOrder.DocNumber`	string	Optional	Reference number for the change order (for example, CO-001 ). If not provided, the value is null.
`$ (anyOf 16).ChangeOrder.EmailStatus`	string	Optional	Email status of the change order. Valid values: NotSet , NeedToSend , EmailSent .
`$ (anyOf 16).ChangeOrder.ExpirationDate`	string	Optional	Date by which the change order must be accepted before it expires.
`$ (anyOf 16).ChangeOrder.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 16).ChangeOrder.Line`	array	Required within parent	Individual line items describing the work being added or removed. Each line must include a LinkedTxn array referencing the parent project estimate with TxnType: “Estimate” . All lines must reference the same parent estimate. Supports SalesItemLineDetail line type.
`$ (anyOf 16).ChangeOrder.Line[]`	Model	Each item	Expand Create a change order — request body — body Line item
`$ (anyOf 16).ChangeOrder.LinkedTxn`	array	Optional	One or more linked transaction references at the header level, reflecting the parent project estimate. Also appears on each line item. Use LinkedTxn.TxnId as the ID in a separate Estimate read request to retrieve details of the linked object. TxnType must always be Estimate .
`$ (anyOf 16).ChangeOrder.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 16).ChangeOrder.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 16).ChangeOrder.PrintStatus`	string	Optional	Printing status of the change order. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 16).ChangeOrder.PrivateNote`	string	Optional	Organization-private note about the change order. This note does not appear on documents sent to the customer.
`$ (anyOf 16).ChangeOrder.ProjectRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to the project this change order belongs to. The project must be active. Without a valid ProjectRef , the change order will not appear in the Projects dashboard.
`$ (anyOf 16).ChangeOrder.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fail. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 16).ChangeOrder.TotalAmt`	JSON	Optional	Total amount of the transaction including all line charges and taxes. Calculated by QuickBooks business logic from the sum of all line Amount values plus applicable tax. Do not include in create or update request bodies; any value supplied is overwritten. Decimal string Read only: true
`$ (anyOf 16).ChangeOrder.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 16).ChangeOrder.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 16).ChangeOrder.TotalCostAmount`	JSON	Optional	Total cost amount of the transaction, calculated from the sum of all line CostAmount values. Calculated by QuickBooks business logic; any value supplied is overwritten. Decimal string Read only: true
`$ (anyOf 16).ChangeOrder.TotalCostAmount (anyOf 1)`	number	Alternative
`$ (anyOf 16).ChangeOrder.TotalCostAmount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 16).ChangeOrder.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. If not supplied, the current date on the server is used.
`$ (anyOf 16).ChangeOrder.TxnStatus`	string	Optional	Current status of the change order. Valid values: Pending , Accepted , Closed , Rejected .
`$ (anyOf 16).ChangeOrder.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail Tax details for the transaction. Captures sales taxes calculated based on tax codes referenced by the transaction lines.
`$ (anyOf 16).ChangeOrder.domain`	string	Optional
`$ (anyOf 16).ChangeOrder.sparse`	boolean	Optional
`$ (anyOf 17)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 17).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 17).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 17).ChangeOrder`	Model	Required within parent	Expand Delete a change order — request body — body
`$ (anyOf 18)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 18).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 18).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 18).ChangeOrder`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 18).ChangeOrder.AcceptedBy`	string	Optional	Name of the customer or representative who accepted the change order. Populated when TxnStatus is set to Accepted .
`$ (anyOf 18).ChangeOrder.AcceptedDate`	string	Optional	Date the change order was accepted. Populated when TxnStatus is set to Accepted .
`$ (anyOf 18).ChangeOrder.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, sales tax is calculated first and then any discount is applied. If true , the discount is subtracted first and then sales tax is calculated.
`$ (anyOf 18).ChangeOrder.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 18).ChangeOrder.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 18).ChangeOrder.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Email address where the change order is sent. Required when EmailStatus is set to NeedToSend . Conditionally required
`$ (anyOf 18).ChangeOrder.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; visible on the Change Order document sent to the customer.
`$ (anyOf 18).ChangeOrder.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the customer associated with this change order. Must match the customer on the parent project estimate. Use Customer.Id and Customer.DisplayName from the Customer object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 18).ChangeOrder.DocNumber`	string	Optional	Reference number for the change order (for example, CO-001 ). If not provided, the value is null.
`$ (anyOf 18).ChangeOrder.EmailStatus`	string	Optional	Email status of the change order. Valid values: NotSet , NeedToSend , EmailSent .
`$ (anyOf 18).ChangeOrder.ExpirationDate`	string	Optional	Date by which the change order must be accepted before it expires.
`$ (anyOf 18).ChangeOrder.Id`	string	Required within parent
`$ (anyOf 18).ChangeOrder.Line`	array	Optional	Individual line items describing the work being added or removed. Supports SalesItemLineDetail and SubTotalLineDetail line types. Every line must include a LinkedTxn array referencing the parent project estimate with TxnType: “Estimate” . All lines must reference the same parent estimate. The Line array uses full-replace behavior on update — lines omitted from an update request are deleted.
`$ (anyOf 18).ChangeOrder.Line[]`	JSON	Each item
`$ (anyOf 18).ChangeOrder.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 18).ChangeOrder.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 18).ChangeOrder.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 18).ChangeOrder.LinkedTxn`	array	Optional	One or more linked transaction references at the header level, reflecting the parent project estimate. Also appears on each line item. Use LinkedTxn.TxnId as the ID in a separate Estimate read request to retrieve details of the linked object. TxnType must always be Estimate .
`$ (anyOf 18).ChangeOrder.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 18).ChangeOrder.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 18).ChangeOrder.PrintStatus`	string	Optional	Printing status of the change order. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 18).ChangeOrder.PrivateNote`	string	Optional	Organization-private note about the change order. This note does not appear on documents sent to the customer.
`$ (anyOf 18).ChangeOrder.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the project this change order belongs to. Must reference an active project. Without a valid ProjectRef , the change order will not appear in the Projects dashboard.
`$ (anyOf 18).ChangeOrder.SyncToken`	string	Required within parent
`$ (anyOf 18).ChangeOrder.TotalAmt`	JSON	Optional	Total amount of the transaction including all line charges and taxes. Calculated by QuickBooks business logic from the sum of all line Amount values plus applicable tax. Do not include in create or update request bodies; any value supplied is overwritten. Decimal string Read only: true
`$ (anyOf 18).ChangeOrder.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 18).ChangeOrder.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 18).ChangeOrder.TotalCostAmount`	JSON	Optional	Total cost amount of the transaction, calculated from the sum of all line CostAmount values. Calculated by QuickBooks business logic; any value supplied is overwritten. Decimal string Read only: true
`$ (anyOf 18).ChangeOrder.TotalCostAmount (anyOf 1)`	number	Alternative
`$ (anyOf 18).ChangeOrder.TotalCostAmount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 18).ChangeOrder.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 18).ChangeOrder.TxnStatus`	string	Optional	Current status of the change order. Valid values: Pending (default — created but not yet reviewed), Accepted (customer approved; project contracted total increases accordingly), Closed (converted to an Invoice or manually closed), Rejected (customer declined; does not affect project total).
`$ (anyOf 18).ChangeOrder.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail Tax details for the transaction. Captures sales taxes calculated based on tax codes referenced by the transaction lines.
`$ (anyOf 18).ChangeOrder.domain`	string	Optional
`$ (anyOf 18).ChangeOrder.sparse`	boolean	Optional
`$ (anyOf 19)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 19).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 19).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 19).Class`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 19).Class.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 19).Class.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 19).Class.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 19).Class.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub class separated by colons. Takes the form of Parent:Class1:SubClass1:SubClass2 . Limited to 5 levels. Read only: true
`$ (anyOf 19).Class.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 19).Class.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 19).Class.Name`	string	Required within parent	User recognizable name for the Class.
`$ (anyOf 19).Class.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To For class objects that are sub-classes: the immediate parent of this object. Required if this object is a subclass. Conditionally required
`$ (anyOf 19).Class.SubClass`	JSON	Optional	Specifies whether this object is a subclass. true —this object represents a subclass. false or null—this object represents a top-level class.
`$ (anyOf 19).Class.SubClass (anyOf 1)`	boolean	Alternative
`$ (anyOf 19).Class.SubClass (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 19).Class.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 19).Class.domain`	string	Optional
`$ (anyOf 19).Class.sparse`	boolean	Optional
`$ (anyOf 20)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 20).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 20).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 20).Class`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 20).Class.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 20).Class.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 20).Class.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 20).Class.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub class separated by colons. Takes the form of Parent:Class1:SubClass1:SubClass2 . Limited to 5 levels. Read only: true
`$ (anyOf 20).Class.Id`	string	Required within parent
`$ (anyOf 20).Class.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 20).Class.Name`	string	Optional	User recognizable name for the Class.
`$ (anyOf 20).Class.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The immediate parent of the SubClass. Required if this object is a subclass. Conditionally required
`$ (anyOf 20).Class.SubClass`	JSON	Optional	Specifies whether this object is a subclass. true —this object represents a subclass. false or null—this object represents a top-level class.
`$ (anyOf 20).Class.SubClass (anyOf 1)`	boolean	Alternative
`$ (anyOf 20).Class.SubClass (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 20).Class.SyncToken`	string	Required within parent
`$ (anyOf 20).Class.domain`	string	Optional
`$ (anyOf 20).Class.sparse`	boolean	Optional
`$ (anyOf 21)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 21).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 21).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 21).CompanyCurrency`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 21).CompanyCurrency.Active`	JSON	Optional	Indicates whether this currency is active in the company or not. true —This currency is active and enabled for use by QuickBooks. false —This currency is inactive, is hidden from most display purposes, and is not availble for use with financial transactions.
`$ (anyOf 21).CompanyCurrency.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 21).CompanyCurrency.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 21).CompanyCurrency.Code`	string	Required within parent	A three letter string representing the ISO 4217 code for the currency. For example, USD , AUD , EUR , and so on.
`$ (anyOf 21).CompanyCurrency.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 21).CompanyCurrency.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 21).CompanyCurrency.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 21).CompanyCurrency.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 21).CompanyCurrency.Name`	string	Optional	The full name of the currency.
`$ (anyOf 21).CompanyCurrency.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 21).CompanyCurrency.domain`	string	Optional
`$ (anyOf 21).CompanyCurrency.sparse`	boolean	Optional
`$ (anyOf 22)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 22).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 22).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 22).CompanyCurrency`	Model	Required within parent	Expand Update a companycurrency — request body — body
`$ (anyOf 23)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 23).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 23).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 23).CompanyInfo`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 23).CompanyInfo.CompanyAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Company Address as described in preference. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 23).CompanyInfo.CompanyName`	string	Optional	The name of the company.
`$ (anyOf 23).CompanyInfo.CompanyStartDate`	string	Optional	DateTime when company file was created. This field and Metadata.CreateTime contain the same value. Read only: true
`$ (anyOf 23).CompanyInfo.Country`	string	Optional	Country name to which the company belongs for financial calculations.
`$ (anyOf 23).CompanyInfo.CustomerCommunicationAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address of the company as given to their customer, sometimes the address given to the customer mail address is different from Company address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 23).CompanyInfo.Email`	Model	Optional	Expand Full update companyinfo — request body — body Email Default email address.
`$ (anyOf 23).CompanyInfo.EmployerId`	string	Optional	If your QuickBooks company has defined an EIN in company settings, this value is returned.
`$ (anyOf 23).CompanyInfo.FiscalYearStartMonth`	string	Optional	The start month of fiscal year.
`$ (anyOf 23).CompanyInfo.Id`	string	Required within parent
`$ (anyOf 23).CompanyInfo.LegalAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Legal Address given to the government for any government communication. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 23).CompanyInfo.LegalName`	string	Optional	The legal name of the company.
`$ (anyOf 23).CompanyInfo.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 23).CompanyInfo.NameValue`	array	Optional	Any other preference not covered with the standard set of attributes. See Data Services Extensions, below, for special reserved name/value pairs. NameValue.Name—Name of the element. NameValue.Value—Value of the element.
`$ (anyOf 23).CompanyInfo.NameValue[]`	object	Each item	Additional keys: allowed
`$ (anyOf 23).CompanyInfo.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 23).CompanyInfo.SupportedLanguages`	string	Optional	Comma separated list of languages.
`$ (anyOf 23).CompanyInfo.SyncToken`	string	Required within parent
`$ (anyOf 23).CompanyInfo.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 23).CompanyInfo.domain`	string	Optional
`$ (anyOf 23).CompanyInfo.sparse`	boolean	Optional
`$ (anyOf 24)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 24).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 24).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 24).CompanyInfo`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 24).CompanyInfo.CompanyAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Company Address as described in preference. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 24).CompanyInfo.CompanyName`	string	Optional	The name of the company.
`$ (anyOf 24).CompanyInfo.CompanyStartDate`	string	Optional	DateTime when company file was created. This field and Metadata.CreateTime contain the same value. Read only: true
`$ (anyOf 24).CompanyInfo.Country`	string	Optional	Country name to which the company belongs for financial calculations.
`$ (anyOf 24).CompanyInfo.CustomerCommunicationAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address of the company as given to their customer, sometimes the address given to the customer mail address is different from Company address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 24).CompanyInfo.Email`	Model	Optional	Expand Full update companyinfo — request body — body Email Default email address.
`$ (anyOf 24).CompanyInfo.EmployerId`	string	Optional	If your QuickBooks company has defined an EIN in company settings, this value is returned.
`$ (anyOf 24).CompanyInfo.FiscalYearStartMonth`	string	Optional	The start month of fiscal year.
`$ (anyOf 24).CompanyInfo.Id`	string	Required within parent
`$ (anyOf 24).CompanyInfo.LegalAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Legal Address given to the government for any government communication. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 24).CompanyInfo.LegalName`	string	Optional	The legal name of the company.
`$ (anyOf 24).CompanyInfo.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 24).CompanyInfo.NameValue`	array	Optional	Any other preference not covered with the standard set of attributes. See Data Services Extensions, below, for special reserved name/value pairs. NameValue.Name—Name of the element. NameValue.Value—Value of the element.
`$ (anyOf 24).CompanyInfo.NameValue[]`	object	Each item	Additional keys: allowed
`$ (anyOf 24).CompanyInfo.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 24).CompanyInfo.SupportedLanguages`	string	Optional	Comma separated list of languages.
`$ (anyOf 24).CompanyInfo.SyncToken`	string	Required within parent
`$ (anyOf 24).CompanyInfo.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 24).CompanyInfo.domain`	string	Optional
`$ (anyOf 24).CompanyInfo.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 25)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 25).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 25).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 25).CreditCardPayment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 25).CreditCardPayment.Amount`	JSON	Required within parent	Total amount of the payment. Denominated in the currency of the credit card account. Decimal string
`$ (anyOf 25).CreditCardPayment.Amount (anyOf 1)`	number	Alternative
`$ (anyOf 25).CreditCardPayment.Amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 25).CreditCardPayment.BankAccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Bank account used to pay the Credit Card balance. Must be a Bank account.
`$ (anyOf 25).CreditCardPayment.CheckNum`	string	Optional	User entered, Check number. This field maps to the Check no. field on the Pay down credit card form.
`$ (anyOf 25).CreditCardPayment.CreditCardAccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Credit Card account for which a payment is being entered. Must be a Credit Card account.
`$ (anyOf 25).CreditCardPayment.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 25).CreditCardPayment.Memo`	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
`$ (anyOf 25).CreditCardPayment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 25).CreditCardPayment.PrintStatus`	string	Optional	Printing status of the credit-card-payment. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 25).CreditCardPayment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
`$ (anyOf 25).CreditCardPayment.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 25).CreditCardPayment.TxnDate`	string	Required within parent	Date of transaction.
`$ (anyOf 25).CreditCardPayment.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 25).CreditCardPayment.domain`	string	Optional
`$ (anyOf 25).CreditCardPayment.sparse`	boolean	Optional
`$ (anyOf 26)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 26).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 26).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 26).CreditCardPayment`	Model	Required within parent	Expand Delete a creditcardpayment — request body — body
`$ (anyOf 27)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 27).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 27).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 27).CreditCardPayment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 27).CreditCardPayment.Amount`	JSON	Optional	Total amount of the payment. Denominated in the currency of the credit card account. Decimal string
`$ (anyOf 27).CreditCardPayment.Amount (anyOf 1)`	number	Alternative
`$ (anyOf 27).CreditCardPayment.Amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 27).CreditCardPayment.BankAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Bank account used to pay the Credit Card balance. Must be a Bank account.
`$ (anyOf 27).CreditCardPayment.CheckNum`	string	Optional	User entered, Check number. This field maps to the Check no. field on the Pay down credit card form.
`$ (anyOf 27).CreditCardPayment.CreditCardAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Credit Card account for which a payment is being entered. Must be a Credit Card account.
`$ (anyOf 27).CreditCardPayment.Id`	string	Required within parent
`$ (anyOf 27).CreditCardPayment.Memo`	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
`$ (anyOf 27).CreditCardPayment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 27).CreditCardPayment.PrintStatus`	string	Optional	Printing status of the credit-card-payment. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 27).CreditCardPayment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
`$ (anyOf 27).CreditCardPayment.SyncToken`	string	Required within parent
`$ (anyOf 27).CreditCardPayment.TxnDate`	string	Optional	Date of transaction.
`$ (anyOf 27).CreditCardPayment.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 27).CreditCardPayment.domain`	string	Optional
`$ (anyOf 27).CreditCardPayment.sparse`	boolean	Optional
`$ (anyOf 28)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 28).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 28).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 28).CreditCardPayment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 28).CreditCardPayment.Amount`	JSON	Optional	Total amount of the payment. Denominated in the currency of the credit card account. Decimal string
`$ (anyOf 28).CreditCardPayment.Amount (anyOf 1)`	number	Alternative
`$ (anyOf 28).CreditCardPayment.Amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 28).CreditCardPayment.BankAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Bank account used to pay the Credit Card balance. Must be a Bank account.
`$ (anyOf 28).CreditCardPayment.CheckNum`	string	Optional	User entered, Check number. This field maps to the Check no. field on the Pay down credit card form.
`$ (anyOf 28).CreditCardPayment.CreditCardAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Credit Card account for which a payment is being entered. Must be a Credit Card account.
`$ (anyOf 28).CreditCardPayment.Id`	string	Required within parent
`$ (anyOf 28).CreditCardPayment.Memo`	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
`$ (anyOf 28).CreditCardPayment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 28).CreditCardPayment.PrintStatus`	string	Optional	Printing status of the credit-card-payment. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 28).CreditCardPayment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
`$ (anyOf 28).CreditCardPayment.SyncToken`	string	Required within parent
`$ (anyOf 28).CreditCardPayment.TxnDate`	string	Optional	Date of transaction.
`$ (anyOf 28).CreditCardPayment.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 28).CreditCardPayment.domain`	string	Optional
`$ (anyOf 28).CreditCardPayment.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 29)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 29).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 29).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 29).CreditMemo`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 29).CreditMemo.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. US versions of QuickBooks only.
`$ (anyOf 29).CreditMemo.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 29).CreditMemo.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 29).CreditMemo.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 29).CreditMemo.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 29).CreditMemo.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 29).CreditMemo.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the credit memo. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 29).CreditMemo.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the credit-memo is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 29).CreditMemo.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerLine is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 29).CreditMemo.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 29).CreditMemo.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 29).CreditMemo.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 29).CreditMemo.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 29).CreditMemo.CustomerRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 29).CreditMemo.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 29).CreditMemo.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 29).CreditMemo.EmailStatus`	string	Optional	Email status of the credit-memo. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 29).CreditMemo.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 29).CreditMemo.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 29).CreditMemo.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 29).CreditMemo.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 29).CreditMemo.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 29).CreditMemo.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 29).CreditMemo.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 29).CreditMemo.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 29).CreditMemo.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 29).CreditMemo.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 29).CreditMemo.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 29).CreditMemo.Line`	array	Required within parent	The minimum line item required for the request is one of the following. Sales item line type Group item line type
`$ (anyOf 29).CreditMemo.Line[]`	JSON	Each item
`$ (anyOf 29).CreditMemo.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 29).CreditMemo.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 29).CreditMemo.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 29).CreditMemo.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 29).CreditMemo.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 29).CreditMemo.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively. Read only: true
`$ (anyOf 29).CreditMemo.PrintStatus`	string	Optional	Printing status of the credit-memo. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 29).CreditMemo.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the deposit form.
`$ (anyOf 29).CreditMemo.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 29).CreditMemo.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the CreditMemo was created from. Read only: true
`$ (anyOf 29).CreditMemo.RemainingCredit`	JSON	Optional	Indicates the total credit amount still available to apply towards the payment. Decimal string Read only: true
`$ (anyOf 29).CreditMemo.RemainingCredit (anyOf 1)`	number	Alternative
`$ (anyOf 29).CreditMemo.RemainingCredit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 29).CreditMemo.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 29).CreditMemo.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 29).CreditMemo.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 29).CreditMemo.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 29).CreditMemo.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string
`$ (anyOf 29).CreditMemo.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 29).CreditMemo.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 29).CreditMemo.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 29).CreditMemo.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 29).CreditMemo.domain`	string	Optional
`$ (anyOf 29).CreditMemo.sparse`	boolean	Optional
`$ (anyOf 30)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 30).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 30).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 30).CreditMemo`	Model	Required within parent	Expand Delete a credit memo — request body — body
`$ (anyOf 31)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 31).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 31).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 31).CreditMemo`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 31).CreditMemo.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. US versions of QuickBooks only.
`$ (anyOf 31).CreditMemo.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 31).CreditMemo.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 31).CreditMemo.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 31).CreditMemo.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 31).CreditMemo.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 31).CreditMemo.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the credit memo. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 31).CreditMemo.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the credit-memo is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 31).CreditMemo.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerLine is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 31).CreditMemo.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 31).CreditMemo.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 31).CreditMemo.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 31).CreditMemo.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 31).CreditMemo.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 31).CreditMemo.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 31).CreditMemo.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 31).CreditMemo.EmailStatus`	string	Optional	Email status of the credit-memo. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 31).CreditMemo.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 31).CreditMemo.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 31).CreditMemo.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 31).CreditMemo.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 31).CreditMemo.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 31).CreditMemo.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 31).CreditMemo.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 31).CreditMemo.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 31).CreditMemo.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 31).CreditMemo.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 31).CreditMemo.Id`	string	Required within parent
`$ (anyOf 31).CreditMemo.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine , DiscountLine and SubTotalLine
`$ (anyOf 31).CreditMemo.Line[]`	JSON	Each item
`$ (anyOf 31).CreditMemo.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 31).CreditMemo.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 31).CreditMemo.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 31).CreditMemo.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 31).CreditMemo.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 31).CreditMemo.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 31).CreditMemo.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively. Read only: true
`$ (anyOf 31).CreditMemo.PrintStatus`	string	Optional	Printing status of the credit-memo. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 31).CreditMemo.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the deposit form.
`$ (anyOf 31).CreditMemo.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 31).CreditMemo.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the CreditMemo was created from. Read only: true
`$ (anyOf 31).CreditMemo.RemainingCredit`	JSON	Optional	Indicates the total credit amount still available to apply towards the payment. Decimal string Read only: true
`$ (anyOf 31).CreditMemo.RemainingCredit (anyOf 1)`	number	Alternative
`$ (anyOf 31).CreditMemo.RemainingCredit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 31).CreditMemo.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 31).CreditMemo.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 31).CreditMemo.SyncToken`	string	Required within parent
`$ (anyOf 31).CreditMemo.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 31).CreditMemo.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string
`$ (anyOf 31).CreditMemo.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 31).CreditMemo.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 31).CreditMemo.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 31).CreditMemo.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 31).CreditMemo.domain`	string	Optional
`$ (anyOf 31).CreditMemo.sparse`	boolean	Optional
`$ (anyOf 32)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 32).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 32).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 32).Customer`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 32).Customer.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks. If there is an amount in Customer.Balance when setting this Customer object to inactive through the QuickBooks UI, a CreditMemo balancing transaction is created for the amount.
`$ (anyOf 32).Customer.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 32).Customer.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 32).Customer.AlternatePhone`	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
`$ (anyOf 32).Customer.Balance`	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create. Decimal string
`$ (anyOf 32).Customer.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 32).Customer.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 32).Customer.BalanceWithJobs`	JSON	Optional	Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks. Decimal string
`$ (anyOf 32).Customer.BalanceWithJobs (anyOf 1)`	number	Alternative
`$ (anyOf 32).Customer.BalanceWithJobs (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 32).Customer.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 32).Customer.BillWithParent`	JSON	Optional	If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.
`$ (anyOf 32).Customer.BillWithParent (anyOf 1)`	boolean	Alternative
`$ (anyOf 32).Customer.BillWithParent (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 32).Customer.CompanyName`	string	Optional	The name of the company associated with the person or organization.
`$ (anyOf 32).Customer.CurrencyRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the currency in which all amounts associated with this customer are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this customer is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read only: true
`$ (anyOf 32).Customer.CustomerTypeRef`	Model	Optional	Expand Create a customer — request body — body Customer Type Ref Reference to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.
`$ (anyOf 32).Customer.DefaultTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a default tax code associated with this Customer object. Reference is valid if Customer.Taxable is set to true; otherwise, it is ignored. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) the default tax code is set by the system and can not be overridden. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for DefaultTaxCodeRef.value and DefaultTaxCodeRef.name , respectively.
`$ (anyOf 32).Customer.DisplayName`	string	Optional	The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . Conditionally required
`$ (anyOf 32).Customer.FamilyName`	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 32).Customer.Fax`	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
`$ (anyOf 32).Customer.FullyQualifiedName`	string	Optional	Fully qualified name of the object. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Customer:Job:Sub-job . System generated. Limited to 5 levels. Read only: true
`$ (anyOf 32).Customer.GivenName`	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 32).Customer.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 32).Customer.IsProject`	JSON	Optional	If true, indicates this is a Project. Read only: true
`$ (anyOf 32).Customer.IsProject (anyOf 1)`	boolean	Alternative
`$ (anyOf 32).Customer.IsProject (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 32).Customer.Job`	JSON	Optional	If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.
`$ (anyOf 32).Customer.Job (anyOf 1)`	boolean	Alternative
`$ (anyOf 32).Customer.Job (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 32).Customer.Level`	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent. Constraints: up to 5 levels Read only: true
`$ (anyOf 32).Customer.Level (anyOf 1)`	integer	Alternative
`$ (anyOf 32).Customer.Level (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 32).Customer.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 32).Customer.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 32).Customer.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 32).Customer.Notes`	string	Optional	Free form text describing the Customer.
`$ (anyOf 32).Customer.OpenBalanceDate`	string	Optional	Date of the Open Balance for the create operation. Write-on-create.
`$ (anyOf 32).Customer.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 32).Customer.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 32).Customer.PreferredDeliveryMethod`	string	Optional	Preferred delivery method. Values are Print, Email, or None.
`$ (anyOf 32).Customer.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 32).Customer.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 32).Customer.PrimaryTaxIdentifier`	string	Optional	Also called Tax Reg. No in ( UK ) , ( CA ) , ( IN ) , ( AU ) represents the tax ID of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
`$ (anyOf 32).Customer.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. Constraints: Cannot be removed with sparse update.
`$ (anyOf 32).Customer.ResaleNum`	string	Optional	Resale number or some additional info about the customer.
`$ (anyOf 32).Customer.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a SalesTerm associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 32).Customer.SecondaryTaxIdentifier`	string	Optional	Also called UTR No. in ( UK ) , CST Reg No. ( IN ) also represents the tax registration number of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
`$ (anyOf 32).Customer.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default shipping address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 32).Customer.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 32).Customer.Suffix`	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 32).Customer.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 32).Customer.TaxExemptionReasonId`	string	Optional	The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) for the company. Set TaxExemptionReasonId: to one of the following: Id Reason 1 Federal government 2 State government 3 Local government 4 Tribal government 5 Charitable organization 6 Religious organization 7 Educational organization 8 Hospital 9 Resale 10 Direct pay permit 11 Multiple points of use 12 Direct mail 13 Agricultural production 14 Industrial production / manufacturing 15 Foreign diplomat
`$ (anyOf 32).Customer.Taxable`	JSON	Optional	If true, transactions for this customer are taxable. Default behavior: true, if DefaultTaxCodeRef is defined or false if TaxExemptionReasonId is set.
`$ (anyOf 32).Customer.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 32).Customer.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 32).Customer.Title`	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , Suffix , or FullyQualifiedName attributes are required during create. Conditionally required
`$ (anyOf 32).Customer.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 32).Customer.domain`	string	Optional
`$ (anyOf 32).Customer.sparse`	boolean	Optional
`$ (anyOf 33)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 33).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 33).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 33).Customer`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 33).Customer.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks. If there is an amount in Customer.Balance when setting this Customer object to inactive through the QuickBooks UI, a CreditMemo balancing transaction is created for the amount.
`$ (anyOf 33).Customer.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 33).Customer.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 33).Customer.AlternatePhone`	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
`$ (anyOf 33).Customer.Balance`	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create. Decimal string
`$ (anyOf 33).Customer.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 33).Customer.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 33).Customer.BalanceWithJobs`	JSON	Optional	Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks. Decimal string
`$ (anyOf 33).Customer.BalanceWithJobs (anyOf 1)`	number	Alternative
`$ (anyOf 33).Customer.BalanceWithJobs (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 33).Customer.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 33).Customer.BillWithParent`	JSON	Optional	If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.
`$ (anyOf 33).Customer.BillWithParent (anyOf 1)`	boolean	Alternative
`$ (anyOf 33).Customer.BillWithParent (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 33).Customer.CompanyName`	string	Optional	The name of the company associated with the person or organization.
`$ (anyOf 33).Customer.CurrencyRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the currency in which all amounts associated with this customer are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this customer is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read only: true
`$ (anyOf 33).Customer.CustomerTypeRef`	Model	Optional	Expand Create a customer — request body — body Customer Type Ref Reference to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.
`$ (anyOf 33).Customer.DefaultTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a default tax code associated with this Customer object. Reference is valid if Customer.Taxable is set to true; otherwise, it is ignored. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) the default tax code is set by the system and can not be overridden. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for DefaultTaxCodeRef.value and DefaultTaxCodeRef.name , respectively.
`$ (anyOf 33).Customer.DisplayName`	string	Optional	The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . Conditionally required
`$ (anyOf 33).Customer.FamilyName`	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 33).Customer.Fax`	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
`$ (anyOf 33).Customer.FullyQualifiedName`	string	Optional	Fully qualified name of the object. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Customer:Job:Sub-job . System generated. Limited to 5 levels. Read only: true
`$ (anyOf 33).Customer.GivenName`	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 33).Customer.Id`	string	Required within parent
`$ (anyOf 33).Customer.IsProject`	JSON	Optional	If true, indicates this is a Project. Read only: true
`$ (anyOf 33).Customer.IsProject (anyOf 1)`	boolean	Alternative
`$ (anyOf 33).Customer.IsProject (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 33).Customer.Job`	JSON	Optional	If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.
`$ (anyOf 33).Customer.Job (anyOf 1)`	boolean	Alternative
`$ (anyOf 33).Customer.Job (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 33).Customer.Level`	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent. Constraints: up to 5 levels Read only: true
`$ (anyOf 33).Customer.Level (anyOf 1)`	integer	Alternative
`$ (anyOf 33).Customer.Level (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 33).Customer.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 33).Customer.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 33).Customer.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 33).Customer.Notes`	string	Optional	Free form text describing the Customer.
`$ (anyOf 33).Customer.OpenBalanceDate`	string	Optional	Date of the Open Balance for the create operation. Write-on-create.
`$ (anyOf 33).Customer.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 33).Customer.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 33).Customer.PreferredDeliveryMethod`	string	Optional	Preferred delivery method. Values are Print, Email, or None.
`$ (anyOf 33).Customer.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 33).Customer.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 33).Customer.PrimaryTaxIdentifier`	string	Optional	Also called Tax Reg. No in ( UK ) , ( CA ) , ( IN ) , ( AU ) represents the tax ID of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
`$ (anyOf 33).Customer.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. Constraints: Cannot be removed with sparse update.
`$ (anyOf 33).Customer.ResaleNum`	string	Optional	Resale number or some additional info about the customer.
`$ (anyOf 33).Customer.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a SalesTerm associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 33).Customer.SecondaryTaxIdentifier`	string	Optional	Also called UTR No. in ( UK ) , CST Reg No. ( IN ) also represents the tax registration number of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
`$ (anyOf 33).Customer.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default shipping address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 33).Customer.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 33).Customer.Suffix`	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 33).Customer.SyncToken`	string	Required within parent
`$ (anyOf 33).Customer.TaxExemptionReasonId`	string	Optional	The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) for the company. Set TaxExemptionReasonId: to one of the following: Id Reason 1 Federal government 2 State government 3 Local government 4 Tribal government 5 Charitable organization 6 Religious organization 7 Educational organization 8 Hospital 9 Resale 10 Direct pay permit 11 Multiple points of use 12 Direct mail 13 Agricultural production 14 Industrial production / manufacturing 15 Foreign diplomat
`$ (anyOf 33).Customer.Taxable`	JSON	Optional	If true, transactions for this customer are taxable. Default behavior: true, if DefaultTaxCodeRef is defined or false if TaxExemptionReasonId is set.
`$ (anyOf 33).Customer.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 33).Customer.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 33).Customer.Title`	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 33).Customer.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 33).Customer.domain`	string	Optional
`$ (anyOf 33).Customer.sparse`	boolean	Optional
`$ (anyOf 34)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 34).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 34).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 34).Customer`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 34).Customer.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks. If there is an amount in Customer.Balance when setting this Customer object to inactive through the QuickBooks UI, a CreditMemo balancing transaction is created for the amount.
`$ (anyOf 34).Customer.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 34).Customer.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 34).Customer.AlternatePhone`	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
`$ (anyOf 34).Customer.Balance`	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create. Decimal string
`$ (anyOf 34).Customer.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 34).Customer.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 34).Customer.BalanceWithJobs`	JSON	Optional	Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks. Decimal string
`$ (anyOf 34).Customer.BalanceWithJobs (anyOf 1)`	number	Alternative
`$ (anyOf 34).Customer.BalanceWithJobs (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 34).Customer.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 34).Customer.BillWithParent`	JSON	Optional	If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.
`$ (anyOf 34).Customer.BillWithParent (anyOf 1)`	boolean	Alternative
`$ (anyOf 34).Customer.BillWithParent (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 34).Customer.CompanyName`	string	Optional	The name of the company associated with the person or organization.
`$ (anyOf 34).Customer.CurrencyRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the currency in which all amounts associated with this customer are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this customer is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read only: true
`$ (anyOf 34).Customer.CustomerTypeRef`	Model	Optional	Expand Create a customer — request body — body Customer Type Ref Reference to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.
`$ (anyOf 34).Customer.DefaultTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a default tax code associated with this Customer object. Reference is valid if Customer.Taxable is set to true; otherwise, it is ignored. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) the default tax code is set by the system and can not be overridden. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for DefaultTaxCodeRef.value and DefaultTaxCodeRef.name , respectively.
`$ (anyOf 34).Customer.DisplayName`	string	Optional	The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . Conditionally required
`$ (anyOf 34).Customer.FamilyName`	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 34).Customer.Fax`	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
`$ (anyOf 34).Customer.FullyQualifiedName`	string	Optional	Fully qualified name of the object. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Customer:Job:Sub-job . System generated. Limited to 5 levels. Read only: true
`$ (anyOf 34).Customer.GivenName`	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 34).Customer.Id`	string	Required within parent
`$ (anyOf 34).Customer.IsProject`	JSON	Optional	If true, indicates this is a Project. Read only: true
`$ (anyOf 34).Customer.IsProject (anyOf 1)`	boolean	Alternative
`$ (anyOf 34).Customer.IsProject (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 34).Customer.Job`	JSON	Optional	If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.
`$ (anyOf 34).Customer.Job (anyOf 1)`	boolean	Alternative
`$ (anyOf 34).Customer.Job (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 34).Customer.Level`	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent. Constraints: up to 5 levels Read only: true
`$ (anyOf 34).Customer.Level (anyOf 1)`	integer	Alternative
`$ (anyOf 34).Customer.Level (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 34).Customer.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 34).Customer.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 34).Customer.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 34).Customer.Notes`	string	Optional	Free form text describing the Customer.
`$ (anyOf 34).Customer.OpenBalanceDate`	string	Optional	Date of the Open Balance for the create operation. Write-on-create.
`$ (anyOf 34).Customer.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 34).Customer.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 34).Customer.PreferredDeliveryMethod`	string	Optional	Preferred delivery method. Values are Print, Email, or None.
`$ (anyOf 34).Customer.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 34).Customer.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 34).Customer.PrimaryTaxIdentifier`	string	Optional	Also called Tax Reg. No in ( UK ) , ( CA ) , ( IN ) , ( AU ) represents the tax ID of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
`$ (anyOf 34).Customer.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. Constraints: Cannot be removed with sparse update.
`$ (anyOf 34).Customer.ResaleNum`	string	Optional	Resale number or some additional info about the customer.
`$ (anyOf 34).Customer.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a SalesTerm associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 34).Customer.SecondaryTaxIdentifier`	string	Optional	Also called UTR No. in ( UK ) , CST Reg No. ( IN ) also represents the tax registration number of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
`$ (anyOf 34).Customer.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default shipping address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 34).Customer.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 34).Customer.Suffix`	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 34).Customer.SyncToken`	string	Required within parent
`$ (anyOf 34).Customer.TaxExemptionReasonId`	string	Optional	The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) for the company. Set TaxExemptionReasonId: to one of the following: Id Reason 1 Federal government 2 State government 3 Local government 4 Tribal government 5 Charitable organization 6 Religious organization 7 Educational organization 8 Hospital 9 Resale 10 Direct pay permit 11 Multiple points of use 12 Direct mail 13 Agricultural production 14 Industrial production / manufacturing 15 Foreign diplomat
`$ (anyOf 34).Customer.Taxable`	JSON	Optional	If true, transactions for this customer are taxable. Default behavior: true, if DefaultTaxCodeRef is defined or false if TaxExemptionReasonId is set.
`$ (anyOf 34).Customer.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 34).Customer.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 34).Customer.Title`	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
`$ (anyOf 34).Customer.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 34).Customer.domain`	string	Optional
`$ (anyOf 34).Customer.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 35)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 35).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 35).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 35).Department`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 35).Department.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks. If set to false, this entity is not available.
`$ (anyOf 35).Department.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 35).Department.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 35).Department.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Department1:SubDepartment1:SubDepartment2 . Limited to 5 levels. Read only: true
`$ (anyOf 35).Department.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 35).Department.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 35).Department.Name`	string	Required within parent	User recognizable name for the department.
`$ (anyOf 35).Department.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The immediate parent of the SubDepartment. Required for the create operation if this object is a SubDepartment. Required if this object is a subdepartment Conditionally required
`$ (anyOf 35).Department.SubDepartment`	JSON	Optional	Specifies whether this Department object is a SubDepartment. true —SubDepartment. false or null—top-level Department. Read only: true
`$ (anyOf 35).Department.SubDepartment (anyOf 1)`	boolean	Alternative
`$ (anyOf 35).Department.SubDepartment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 35).Department.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 35).Department.domain`	string	Optional
`$ (anyOf 35).Department.sparse`	boolean	Optional
`$ (anyOf 36)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 36).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 36).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 36).Department`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 36).Department.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks. If set to false, this entity is not available.
`$ (anyOf 36).Department.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 36).Department.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 36).Department.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Department1:SubDepartment1:SubDepartment2 . Limited to 5 levels. Read only: true
`$ (anyOf 36).Department.Id`	string	Required within parent
`$ (anyOf 36).Department.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 36).Department.Name`	string	Optional	User recognizable name for the Department.
`$ (anyOf 36).Department.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The immediate parent of the SubDepartment. Required for the create operation if this object is a SubDepartment. Required if this object is a subdepartment. Conditionally required
`$ (anyOf 36).Department.SubDepartment`	JSON	Optional	Specifies whether this Department object is a SubDepartment. true —SubDepartment. false or null—top-level Department. Read only: true
`$ (anyOf 36).Department.SubDepartment (anyOf 1)`	boolean	Alternative
`$ (anyOf 36).Department.SubDepartment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 36).Department.SyncToken`	string	Required within parent
`$ (anyOf 36).Department.domain`	string	Optional
`$ (anyOf 36).Department.sparse`	boolean	Optional
`$ (anyOf 37)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 37).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 37).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 37).Deposit`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 37).Deposit.CashBack`	Model	Optional	Expand Create a deposit — request body — body Cash Back
`$ (anyOf 37).Deposit.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . The CurrencyRef can be overwritten by the Line.DepositLineDetail Entity. If the customer that you are referring to has a default currency of USD then the currency for this Deposit will always be set as USD. Conditionally required
`$ (anyOf 37).Deposit.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate Department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 37).Deposit.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this deposit. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively.
`$ (anyOf 37).Deposit.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 37).Deposit.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 37).Deposit.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 37).Deposit.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 37).Deposit.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 37).Deposit.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 37).Deposit.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 37).Deposit.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 37).Deposit.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: DepositLine
`$ (anyOf 37).Deposit.Line[]`	Model	Each item	Expand Create a deposit — request body — body Line item
`$ (anyOf 37).Deposit.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 37).Deposit.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 37).Deposit.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Deposit was created from. Read only: true
`$ (anyOf 37).Deposit.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 37).Deposit.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 37).Deposit.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 37).Deposit.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 37).Deposit.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 37).Deposit.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 37).Deposit.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 37).Deposit.domain`	string	Optional
`$ (anyOf 37).Deposit.sparse`	boolean	Optional
`$ (anyOf 38)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 38).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 38).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 38).Deposit`	Model	Required within parent	Expand Delete a deposit — request body — body
`$ (anyOf 39)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 39).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 39).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 39).Deposit`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 39).Deposit.CashBack`	Model	Optional	Expand Create a deposit — request body — body Cash Back
`$ (anyOf 39).Deposit.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . The CurrencyRef can be overwritten by the Line.DepositLineDetail Entity. If the customer that you are referring to has a default currency of USD then the currency for this Deposit will always be set as USD. Conditionally required
`$ (anyOf 39).Deposit.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate Department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 39).Deposit.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this deposit. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively.
`$ (anyOf 39).Deposit.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 39).Deposit.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 39).Deposit.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 39).Deposit.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 39).Deposit.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 39).Deposit.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 39).Deposit.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 39).Deposit.Id`	string	Required within parent
`$ (anyOf 39).Deposit.Line`	array	Optional	Individual line items comprising the deposit. Specify a Line.LinkedTxn element along with DepositLine detail type if this line is to record a deposit for an existing transaction. Select UndepositedFunds account on the existing transaction to make it available for the Deposit. Possible types of transactions that can be linked to a Deposit include: Transfer , Payment (for Cash, CreditCard, and Check payment method types), SalesReceipt , RefundReceipt , JournalEntry . In addition, any expense object whose line item has AccountReceivable can be linked to a Payment and then that Payment can be linked to a Deposit object. Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object. Valid Line types include: LinkedTxn and DepositLine
`$ (anyOf 39).Deposit.Line[]`	JSON	Each item
`$ (anyOf 39).Deposit.Line[] (anyOf 1)`	Model	Alternative	Expand Void a payment — request body — body Line item
`$ (anyOf 39).Deposit.Line[] (anyOf 2)`	Model	Alternative	Expand Create a deposit — request body — body Line item
`$ (anyOf 39).Deposit.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 39).Deposit.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 39).Deposit.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Deposit was created from. Read only: true
`$ (anyOf 39).Deposit.SyncToken`	string	Required within parent
`$ (anyOf 39).Deposit.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 39).Deposit.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 39).Deposit.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 39).Deposit.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 39).Deposit.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 39).Deposit.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 39).Deposit.domain`	string	Optional
`$ (anyOf 39).Deposit.sparse`	boolean	Optional
`$ (anyOf 40)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 40).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 40).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 40).Deposit`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 40).Deposit.CashBack`	Model	Optional	Expand Create a deposit — request body — body Cash Back
`$ (anyOf 40).Deposit.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . The CurrencyRef can be overwritten by the Line.DepositLineDetail Entity. If the customer that you are referring to has a default currency of USD then the currency for this Deposit will always be set as USD. Conditionally required
`$ (anyOf 40).Deposit.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate Department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 40).Deposit.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this deposit. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively.
`$ (anyOf 40).Deposit.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 40).Deposit.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 40).Deposit.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 40).Deposit.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 40).Deposit.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 40).Deposit.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 40).Deposit.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 40).Deposit.Id`	string	Required within parent
`$ (anyOf 40).Deposit.Line`	array	Optional	Individual line items comprising the deposit. Specify a Line.LinkedTxn element along with DepositLine detail type if this line is to record a deposit for an existing transaction. Select UndepositedFunds account on the existing transaction to make it available for the Deposit. Possible types of transactions that can be linked to a Deposit include: Transfer , Payment (for Cash, CreditCard, and Check payment method types), SalesReceipt , RefundReceipt , JournalEntry . In addition, any expense object whose line item has AccountReceivable can be linked to a Payment and then that Payment can be linked to a Deposit object. Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object. Valid Line types include: LinkedTxn and DepositLine
`$ (anyOf 40).Deposit.Line[]`	JSON	Each item
`$ (anyOf 40).Deposit.Line[] (anyOf 1)`	Model	Alternative	Expand Void a payment — request body — body Line item
`$ (anyOf 40).Deposit.Line[] (anyOf 2)`	Model	Alternative	Expand Create a deposit — request body — body Line item
`$ (anyOf 40).Deposit.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 40).Deposit.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 40).Deposit.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Deposit was created from. Read only: true
`$ (anyOf 40).Deposit.SyncToken`	string	Required within parent
`$ (anyOf 40).Deposit.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 40).Deposit.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 40).Deposit.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 40).Deposit.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 40).Deposit.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 40).Deposit.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 40).Deposit.domain`	string	Optional
`$ (anyOf 40).Deposit.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 41)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 41).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 41).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 41).Employee`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 41).Employee.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 41).Employee.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 41).Employee.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 41).Employee.BillRate`	JSON	Optional	This attribute can only be set if BillableTime is true. Not supported when QuickBooks Payroll is enabled. Decimal string
`$ (anyOf 41).Employee.BillRate (anyOf 1)`	number	Alternative
`$ (anyOf 41).Employee.BillRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 41).Employee.BillableTime`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 41).Employee.BillableTime (anyOf 1)`	boolean	Alternative
`$ (anyOf 41).Employee.BillableTime (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 41).Employee.BirthDate`	string	Optional	Birth date of the employee.
`$ (anyOf 41).Employee.CostRate`	JSON	Optional	Pay rate of the employee Decimal string
`$ (anyOf 41).Employee.CostRate (anyOf 1)`	number	Alternative
`$ (anyOf 41).Employee.CostRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 41).Employee.DisplayName`	string	Optional	The name of the person or organization as displayed. Default Value: If not supplied, the system generates DisplayName by concatenating employee name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . When QuickBooks Payroll is enabled, this attribute is read-only and a concatenation of GivenName , MiddleName , and FamilyName .
`$ (anyOf 41).Employee.EmployeeNumber`	string	Optional	Specifies the ID number of the employee in the employer’s directory.
`$ (anyOf 41).Employee.FamilyName`	string	Optional	Family name or the last name of the person. At least one of GivenName or FamilyName attributes is required.
`$ (anyOf 41).Employee.Gender`	string	Optional	Gender of the employee. To clear the gender value, set to Null in a full update request. Supported values include: Male or Female .
`$ (anyOf 41).Employee.GivenName`	string	Optional	Given name or Family name of a person. At least one of GivenName or FamilyName attributes is required.
`$ (anyOf 41).Employee.HiredDate`	string	Optional	Hire date of the employee.
`$ (anyOf 41).Employee.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 41).Employee.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 41).Employee.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names.
`$ (anyOf 41).Employee.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 41).Employee.Organization`	JSON	Optional	true —the object represents an organization. false —the object represents a person.
`$ (anyOf 41).Employee.Organization (anyOf 1)`	boolean	Alternative
`$ (anyOf 41).Employee.Organization (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 41).Employee.PrimaryAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Represents the physical street address for this employee. If QuickBooks Payroll is enabled for the company, the following PhysicalAddress fields are required: City , maximum of 255 chars CountrySubDivisionCode , maximum of 255 chars PostalCode Required when QuickBooks Payroll is enabled. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 41).Employee.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 41).Employee.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 41).Employee.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName . Cannot be removed with sparse update. Not supported when QuickBooks Payroll is enabled.
`$ (anyOf 41).Employee.ReleasedDate`	string	Optional	Release date of the employee.
`$ (anyOf 41).Employee.SSN`	string	Optional	Social security number (SSN) of the employee. If SSN is set, it is masked in the response with XXX-XX-XXXX. If XXX-XX-XXXX is sent in the create or update request, XXX-XX-XXXX is ignored and the old value is preserved. This attribute cannot be passed in a request when QuickBooks Payroll is enabled. Code for this field must be removed before submitting.
`$ (anyOf 41).Employee.Suffix`	string	Optional	Suffix of the name. For example, Jr . Not supported when QuickBooks Payroll is enabled.
`$ (anyOf 41).Employee.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 41).Employee.Title`	string	Optional	Title of the person. This tag supports i18n, all locale. Not supported when QuickBooks Payroll is enabled.
`$ (anyOf 41).Employee.V4IDPseudonym`	string	Optional	Employee reference number. For internal use only. Read only: true
`$ (anyOf 41).Employee.domain`	string	Optional
`$ (anyOf 41).Employee.sparse`	boolean	Optional
`$ (anyOf 42)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 42).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 42).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 42).Employee`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 42).Employee.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 42).Employee.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 42).Employee.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 42).Employee.BillRate`	JSON	Optional	This attribute can only be set if BillableTime is true. Not supported when QuickBooks Payroll is enabled. Decimal string
`$ (anyOf 42).Employee.BillRate (anyOf 1)`	number	Alternative
`$ (anyOf 42).Employee.BillRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 42).Employee.BillableTime`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 42).Employee.BillableTime (anyOf 1)`	boolean	Alternative
`$ (anyOf 42).Employee.BillableTime (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 42).Employee.BirthDate`	string	Optional	Birth date of the employee.
`$ (anyOf 42).Employee.CostRate`	JSON	Optional	Pay rate of the employee Decimal string
`$ (anyOf 42).Employee.CostRate (anyOf 1)`	number	Alternative
`$ (anyOf 42).Employee.CostRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 42).Employee.DisplayName`	string	Optional	The name of the person or organization as displayed. Default Value: If not supplied, the system generates DisplayName by concatenating employee name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . When QuickBooks Payroll is enabled, this attribute is read-only and a concatenation of GivenName , MiddleName , and FamilyName .
`$ (anyOf 42).Employee.EmployeeNumber`	string	Optional	Specifies the ID number of the employee in the employer’s directory.
`$ (anyOf 42).Employee.FamilyName`	string	Optional	Family name or the last name of the person. At least one of GivenName or FamilyName attributes is required.
`$ (anyOf 42).Employee.Gender`	string	Optional	Gender of the employee. To clear the gender value, set to Null in a full update request. Supported values include: Male or Female .
`$ (anyOf 42).Employee.GivenName`	string	Optional	Given name or family name of a person. At least one of GivenName or FamilyName attributes is required.
`$ (anyOf 42).Employee.HiredDate`	string	Optional	Hire date of the employee.
`$ (anyOf 42).Employee.Id`	string	Required within parent
`$ (anyOf 42).Employee.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 42).Employee.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names.
`$ (anyOf 42).Employee.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 42).Employee.Organization`	JSON	Optional	true —the object represents an organization. false —the object represents a person.
`$ (anyOf 42).Employee.Organization (anyOf 1)`	boolean	Alternative
`$ (anyOf 42).Employee.Organization (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 42).Employee.PrimaryAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Represents the physical street address for this employee. If QuickBooks Payroll is enabled for the company, the following PhysicalAddress fields are required: City , maximum of 255 chars CountrySubDivisionCode , maximum of 255 chars PostalCode Required when QuickBooks Payroll is enabled. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 42).Employee.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 42).Employee.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 42).Employee.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName . Cannot be removed with sparse update. Not supported when QuickBooks Payroll is enabled.
`$ (anyOf 42).Employee.ReleasedDate`	string	Optional	Release date of the employee.
`$ (anyOf 42).Employee.SSN`	string	Optional	Social security number (SSN) of the employee. If SSN is set, it is masked in the response with XXX-XX-XXXX. If XXX-XX-XXXX is sent in the create or update request, XXX-XX-XXXX is ignored and the old value is preserved. This attribute cannot be passed in a request when QuickBooks Payroll is enabled. Code for this field must be removed before submitting.
`$ (anyOf 42).Employee.Suffix`	string	Optional	Suffix of the name. For example, Jr . Not supported when QuickBooks Payroll is enabled.
`$ (anyOf 42).Employee.SyncToken`	string	Required within parent
`$ (anyOf 42).Employee.Title`	string	Optional	Title of the person. This tag supports i18n, all locale. Not supported when QuickBooks Payroll is enabled.
`$ (anyOf 42).Employee.V4IDPseudonym`	string	Optional	Employee reference number. For internal use only. Read only: true
`$ (anyOf 42).Employee.domain`	string	Optional
`$ (anyOf 42).Employee.sparse`	boolean	Optional
`$ (anyOf 43)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 43).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 43).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 43).Estimate`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 43).Estimate.AcceptedBy`	string	Optional	Name of customer who accepted the estimate.
`$ (anyOf 43).Estimate.AcceptedDate`	string	Optional	Date estimate was accepted.
`$ (anyOf 43).Estimate.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`$ (anyOf 43).Estimate.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 43).Estimate.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 43).Estimate.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 43).Estimate.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the estimate is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 43).Estimate.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 43).Estimate.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 43).Estimate.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 43).Estimate.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 43).Estimate.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 43).Estimate.CustomerRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 43).Estimate.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 43).Estimate.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 43).Estimate.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 43).Estimate.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 43).Estimate.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 43).Estimate.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 43).Estimate.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 43).Estimate.ExpirationDate`	string	Optional	Date by which estimate must be accepted before invalidation.
`$ (anyOf 43).Estimate.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 43).Estimate.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 43).Estimate.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 43).Estimate.GlobalTaxCalculation`	string	Optional	TaxExcluded Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable .Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 43).Estimate.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 43).Estimate.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 43).Estimate.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 43).Estimate.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 43).Estimate.Line`	array	Required within parent	The minimum line item required for the request is one of the following. Sales item line type Group item line type
`$ (anyOf 43).Estimate.Line[]`	JSON	Each item
`$ (anyOf 43).Estimate.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 43).Estimate.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 43).Estimate.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 43).Estimate.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 43).Estimate.LinkedTxn`	array	Optional	Zero or more Invoice objects related to this transaction. Use LinkedTxn.TxnId as the ID in a separate Invoice read request to retrieve details of the linked object.
`$ (anyOf 43).Estimate.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 43).Estimate.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 43).Estimate.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 43).Estimate.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 43).Estimate.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. When ProjectRef is passed in the US region for QuickBooks Online Advanced and Intuit Enterprise Suite SKUs, a project estimate is created if the user has projects enabled. Conditionally required
`$ (anyOf 43).Estimate.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Estimate was created from. Read only: true
`$ (anyOf 43).Estimate.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 43).Estimate.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 43).Estimate.ShipDate`	string	Optional	Date for delivery of goods or services.
`$ (anyOf 43).Estimate.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 43).Estimate.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 43).Estimate.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 43).Estimate.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 43).Estimate.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 43).Estimate.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 43).Estimate.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 43).Estimate.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 43).Estimate.TxnStatus`	string	Optional	One of the following status settings: Accepted, Closed, Pending, Rejected, Converted
`$ (anyOf 43).Estimate.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 43).Estimate.domain`	string	Optional
`$ (anyOf 43).Estimate.sparse`	boolean	Optional
`$ (anyOf 44)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 44).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 44).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 44).Estimate`	Model	Required within parent	Expand Delete an estimate — request body — body
`$ (anyOf 45)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 45).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 45).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 45).Estimate`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 45).Estimate.AcceptedBy`	string	Optional	Name of customer who accepted the estimate.
`$ (anyOf 45).Estimate.AcceptedDate`	string	Optional	Date estimate was accepted.
`$ (anyOf 45).Estimate.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`$ (anyOf 45).Estimate.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 45).Estimate.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 45).Estimate.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 45).Estimate.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the estimate is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 45).Estimate.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 45).Estimate.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 45).Estimate.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 45).Estimate.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 45).Estimate.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 45).Estimate.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 45).Estimate.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 45).Estimate.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 45).Estimate.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 45).Estimate.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 45).Estimate.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 45).Estimate.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 45).Estimate.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 45).Estimate.ExpirationDate`	string	Optional	Date by which estimate must be accepted before invalidation.
`$ (anyOf 45).Estimate.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 45).Estimate.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 45).Estimate.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 45).Estimate.GlobalTaxCalculation`	string	Optional	TaxExcluded Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable .Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 45).Estimate.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 45).Estimate.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 45).Estimate.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 45).Estimate.Id`	string	Required within parent
`$ (anyOf 45).Estimate.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine (also used for inline Subtotal lines), DiscountLine and SubTotalLine (used for the overall transaction). If the transaction is taxable there is a limit of 750 lines per transaction.
`$ (anyOf 45).Estimate.Line[]`	JSON	Each item
`$ (anyOf 45).Estimate.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 45).Estimate.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 45).Estimate.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 45).Estimate.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 45).Estimate.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 45).Estimate.LinkedTxn`	array	Optional	Zero or more Invoice objects related to this transaction. Use LinkedTxn.TxnId as the ID in a separate Invoice read request to retrieve details of the linked object.
`$ (anyOf 45).Estimate.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 45).Estimate.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 45).Estimate.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 45).Estimate.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 45).Estimate.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. When ProjectRef is passed in the US region for QuickBooks Online Advanced and Intuit Enterprise Suite SKUs, a project estimate is created if the user has projects enabled. Conditionally required
`$ (anyOf 45).Estimate.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Estimate was created from. Read only: true
`$ (anyOf 45).Estimate.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 45).Estimate.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 45).Estimate.ShipDate`	string	Optional	Date for delivery of goods or services.
`$ (anyOf 45).Estimate.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 45).Estimate.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 45).Estimate.SyncToken`	string	Required within parent
`$ (anyOf 45).Estimate.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 45).Estimate.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 45).Estimate.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 45).Estimate.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 45).Estimate.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 45).Estimate.TxnStatus`	string	Optional	One of the following status settings: Accepted, Closed, Pending, Rejected, Converted
`$ (anyOf 45).Estimate.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 45).Estimate.domain`	string	Optional
`$ (anyOf 45).Estimate.sparse`	boolean	Optional
`$ (anyOf 46)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 46).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 46).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 46).Estimate`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 46).Estimate.AcceptedBy`	string	Optional	Name of customer who accepted the estimate.
`$ (anyOf 46).Estimate.AcceptedDate`	string	Optional	Date estimate was accepted.
`$ (anyOf 46).Estimate.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`$ (anyOf 46).Estimate.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 46).Estimate.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 46).Estimate.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 46).Estimate.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the estimate is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 46).Estimate.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 46).Estimate.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 46).Estimate.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 46).Estimate.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 46).Estimate.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 46).Estimate.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 46).Estimate.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 46).Estimate.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 46).Estimate.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 46).Estimate.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 46).Estimate.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 46).Estimate.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 46).Estimate.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 46).Estimate.ExpirationDate`	string	Optional	Date by which estimate must be accepted before invalidation.
`$ (anyOf 46).Estimate.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 46).Estimate.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 46).Estimate.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 46).Estimate.GlobalTaxCalculation`	string	Optional	TaxExcluded Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable .Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 46).Estimate.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 46).Estimate.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 46).Estimate.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 46).Estimate.Id`	string	Required within parent
`$ (anyOf 46).Estimate.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine (also used for inline Subtotal lines), DiscountLine and SubTotalLine (used for the overall transaction). If the transaction is taxable there is a limit of 750 lines per transaction.
`$ (anyOf 46).Estimate.Line[]`	JSON	Each item
`$ (anyOf 46).Estimate.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 46).Estimate.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 46).Estimate.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 46).Estimate.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 46).Estimate.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 46).Estimate.LinkedTxn`	array	Optional	Zero or more Invoice objects related to this transaction. Use LinkedTxn.TxnId as the ID in a separate Invoice read request to retrieve details of the linked object.
`$ (anyOf 46).Estimate.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 46).Estimate.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 46).Estimate.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 46).Estimate.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 46).Estimate.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. When ProjectRef is passed in the US region for QuickBooks Online Advanced and Intuit Enterprise Suite SKUs, a project estimate is created if the user has projects enabled. Conditionally required
`$ (anyOf 46).Estimate.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Estimate was created from. Read only: true
`$ (anyOf 46).Estimate.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 46).Estimate.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 46).Estimate.ShipDate`	string	Optional	Date for delivery of goods or services.
`$ (anyOf 46).Estimate.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 46).Estimate.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 46).Estimate.SyncToken`	string	Required within parent
`$ (anyOf 46).Estimate.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 46).Estimate.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 46).Estimate.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 46).Estimate.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 46).Estimate.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 46).Estimate.TxnStatus`	string	Optional	One of the following status settings: Accepted, Closed, Pending, Rejected, Converted
`$ (anyOf 46).Estimate.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 46).Estimate.domain`	string	Optional
`$ (anyOf 46).Estimate.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 47)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 47).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 47).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 47).Exchangerate`	Model	Required within parent	Expand Update an exchangerate — request body — body
`$ (anyOf 48)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 48).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 48).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 48).InventoryAdjustment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 48).InventoryAdjustment.AdjustAccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Specifies which account is debited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AdjustAccountRef.value and AdjustAccountRef.name , respectively.
`$ (anyOf 48).InventoryAdjustment.DocNumber`	string	Required within parent	Reference number for the transaction.
`$ (anyOf 48).InventoryAdjustment.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 48).InventoryAdjustment.Line`	array	Required within parent	Individual line items of an inventory adjustment.
`$ (anyOf 48).InventoryAdjustment.Line[]`	Model	Each item	Expand Create an inventory adjustment — request body — body Line item
`$ (anyOf 48).InventoryAdjustment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 48).InventoryAdjustment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Statement Memo field on the Invoice form in the QuickBooks Online UI.
`$ (anyOf 48).InventoryAdjustment.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 48).InventoryAdjustment.TxnDate`	string	Required within parent	The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 48).InventoryAdjustment.domain`	string	Optional
`$ (anyOf 48).InventoryAdjustment.sparse`	boolean	Optional
`$ (anyOf 49)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 49).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 49).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 49).InventoryAdjustment`	Model	Required within parent	Expand Delete an inventory adjustment — request body — body
`$ (anyOf 50)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 50).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 50).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 50).InventoryAdjustment`	Model	Required within parent	Expand Update an inventory adjustment — request body — body
`$ (anyOf 51)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 51).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 51).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 51).Invoice`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 51).Invoice.AllowIPNPayment`	JSON	Optional	Flag to allow payments from legacy Intuit Payment Network (IPN). Provided to maintain backward compatibility and must always be set to false . Do not modify
`$ (anyOf 51).Invoice.AllowIPNPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.AllowIPNPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.AllowOnlineACHPayment`	JSON	Optional	Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online bank transfers. The Bank transfer check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with ACH. If set to false , online bank transfers are not allowed. The Bank transfer check box is not checked on the QuickBooks UI for this invoice.
`$ (anyOf 51).Invoice.AllowOnlineACHPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.AllowOnlineACHPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.AllowOnlineAffirmPayment`	JSON	Optional	Specifies if online Affirm payments are allowed for this invoice and corresponds to the Affirm check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for Affirm with an ACTIVE subscription status. If set to true , allow invoice to be paid with online Affirm payments. The Affirm check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with Affirm. If set to false , online Affirm payments are not allowed. The Affirm check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`$ (anyOf 51).Invoice.AllowOnlineAffirmPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.AllowOnlineAffirmPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.AllowOnlineCreditCardPayment`	JSON	Optional	Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online credit card payments. The Credit card check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with credit cards. If set to false , online credit card payments are not allowed. The Credit card check box is not checked on the QuickBooks UI for this invoice.
`$ (anyOf 51).Invoice.AllowOnlineCreditCardPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.AllowOnlineCreditCardPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.AllowOnlinePayPalPayment`	JSON	Optional	Specifies if online PayPal/Venmo payments are allowed for this invoice and corresponds to the PayPal check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for PayPal with an ACTIVE subscription status. If set to true , allow invoice to be paid with online PayPal payments. The PayPal check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with PayPal. If set to false , online PayPal payments are not allowed. The PayPal check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`$ (anyOf 51).Invoice.AllowOnlinePayPalPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.AllowOnlinePayPalPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.AllowOnlinePayment`	JSON	Optional	Deprecated flag to allow online payments. In use before AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags existed and provided to maintain backward compatibility. If set to true , this invoice was created before AllowOnlinePayment was deprecated and denotes both CC and ACH payments are allowed. In addition, the AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags must be set to true . If set to false , this invoice was created after the AllowOnlinePayment flag was deprecated and is not used. Do not modify.
`$ (anyOf 51).Invoice.AllowOnlinePayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.AllowOnlinePayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`$ (anyOf 51).Invoice.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked transaction against a specific transaction, the balance value won’t change. It will remain the same. Decimal string Read only: true
`$ (anyOf 51).Invoice.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 51).Invoice.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 51).Invoice.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. If you update the CustomerRef , the address passed using BillAddr will be honored.
`$ (anyOf 51).Invoice.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 51).Invoice.BillEmailBcc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the blind carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailBcc . If this email address is invalid, blind carbon copy email is not sent.
`$ (anyOf 51).Invoice.BillEmailCc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailCc . If this email address is invalid, carbon copy email is not sent.
`$ (anyOf 51).Invoice.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 51).Invoice.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 51).Invoice.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 51).Invoice.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 51).Invoice.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 51).Invoice.CustomerRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 51).Invoice.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`$ (anyOf 51).Invoice.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 51).Invoice.Deposit`	JSON	Optional	The deposit made towards this invoice. Decimal string
`$ (anyOf 51).Invoice.Deposit (anyOf 1)`	number	Alternative
`$ (anyOf 51).Invoice.Deposit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 51).Invoice.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. Before you can use this field ensure that the company allows deposits in their invoices first. This can be found by querying the Preferences endpoint . SalesFormsPrefs.AllowDeposit must be equal to true. If you do not specify this account the payment is applied to the Undeposited Funds account.
`$ (anyOf 51).Invoice.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Conditionally required
`$ (anyOf 51).Invoice.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 51).Invoice.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 51).Invoice.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 51).Invoice.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 51).Invoice.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 51).Invoice.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 51).Invoice.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 51).Invoice.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 51).Invoice.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 51).Invoice.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 51).Invoice.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 51).Invoice.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 51).Invoice.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 51).Invoice.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 51).Invoice.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 51).Invoice.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 51).Invoice.InvoiceLink`	string	Optional	Sharable link for the invoice sent to external customers. The link is generated only for invoices with online payment enabled and having a valid customer email address. Include query param `include=invoiceLink` to get the link back on query response. Read only: true
`$ (anyOf 51).Invoice.Line`	array	Required within parent	The minimum line item required for the request is one of the following. SalesItemLine , GroupLine and Inline subtotal using DescriptionOnlyLine
`$ (anyOf 51).Invoice.Line[]`	JSON	Each item
`$ (anyOf 51).Invoice.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 51).Invoice.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 51).Invoice.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 51).Invoice.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 51).Invoice.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 51).Invoice.LinkedTxn`	array	Optional	Zero or more related transactions to this Invoice object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this Invoice object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Progress Invoicing is not supported via the API. Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an Invoice object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 51).Invoice.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 51).Invoice.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 51).Invoice.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 51).Invoice.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Statement Memo field on the Invoice form in the QuickBooks Online UI.
`$ (anyOf 51).Invoice.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 51).Invoice.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Invoice was created from. Read only: true
`$ (anyOf 51).Invoice.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 51).Invoice.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 51).Invoice.ShipDate`	string	Optional	Date for delivery of goods or services.
`$ (anyOf 51).Invoice.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 51).Invoice.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 51).Invoice.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 51).Invoice.TaxExemptionRef`	JSON	Optional
`$ (anyOf 51).Invoice.TaxExemptionRef (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
`$ (anyOf 51).Invoice.TaxExemptionRef (anyOf 2)`	object	Alternative	Maximum fields: 0
`$ (anyOf 51).Invoice.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 51).Invoice.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 51).Invoice.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 51).Invoice.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`$ (anyOf 51).Invoice.TransactionLocationType`	string	Optional	The account location. For UAE, valid values include ABUDHABI AJMAN SHARJAH DUBAI FUJAIRAH RAS_AL_KHAIMAH UMM_AL_QUWAIN OTHER_GCC
`$ (anyOf 51).Invoice.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 51).Invoice.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 51).Invoice.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 51).Invoice.domain`	string	Optional
`$ (anyOf 51).Invoice.sparse`	boolean	Optional
`$ (anyOf 52)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 52).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 52).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 52).Invoice`	Model	Required within parent	Expand Void an invoice — request body — body
`$ (anyOf 53)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 53).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 53).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 53).Invoice`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 53).Invoice.AllowIPNPayment`	JSON	Optional	Flag to allow payments from legacy Intuit Payment Network (IPN). Provided to maintain backward compatibility and must always be set to false . Do not modify
`$ (anyOf 53).Invoice.AllowIPNPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.AllowIPNPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.AllowOnlineACHPayment`	JSON	Optional	Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online bank transfers. The Bank transfer check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with ACH. If set to false , online bank transfers are not allowed. The Bank transfer check box is not checked on the QuickBooks UI for this invoice.
`$ (anyOf 53).Invoice.AllowOnlineACHPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.AllowOnlineACHPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.AllowOnlineAffirmPayment`	JSON	Optional	Specifies if online Affirm payments are allowed for this invoice and corresponds to the Affirm check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for Affirm with an ACTIVE subscription status. If set to true , allow invoice to be paid with online Affirm payments. The Affirm check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with Affirm. If set to false , online Affirm payments are not allowed. The Affirm check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`$ (anyOf 53).Invoice.AllowOnlineAffirmPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.AllowOnlineAffirmPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.AllowOnlineCreditCardPayment`	JSON	Optional	Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online credit card payments. The Credit card check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with credit cards. If set to false , online credit card payments are not allowed. The Credit card check box is not checked on the QuickBooks UI for this invoice.
`$ (anyOf 53).Invoice.AllowOnlineCreditCardPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.AllowOnlineCreditCardPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.AllowOnlinePayPalPayment`	JSON	Optional	Specifies if online PayPal/Venmo payments are allowed for this invoice and corresponds to the PayPal check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for PayPal with an ACTIVE subscription status. If set to true , allow invoice to be paid with online PayPal payments. The PayPal check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with PayPal. If set to false , online PayPal payments are not allowed. The PayPal check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`$ (anyOf 53).Invoice.AllowOnlinePayPalPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.AllowOnlinePayPalPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.AllowOnlinePayment`	JSON	Optional	Deprecated flag to allow online payments. In use before AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags existed and provided to maintain backward compatibility. If set to true , this invoice was created before AllowOnlinePayment was deprecated and denotes both CC and ACH payments are allowed. In addition, the AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags must be set to true . If set to false , this invoice was created after the AllowOnlinePayment flag was deprecated and is not used. Do not modify.
`$ (anyOf 53).Invoice.AllowOnlinePayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.AllowOnlinePayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`$ (anyOf 53).Invoice.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked transaction against a specific transaction, the balance value won’t change. It will remain the same. Decimal string Read only: true
`$ (anyOf 53).Invoice.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 53).Invoice.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 53).Invoice.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. If you update the CustomerRef , the address passed using BillAddr will be honored.
`$ (anyOf 53).Invoice.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 53).Invoice.BillEmailBcc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the blind carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailBcc . If this email address is invalid, blind carbon copy email is not sent.
`$ (anyOf 53).Invoice.BillEmailCc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailCc . If this email address is invalid, carbon copy email is not sent.
`$ (anyOf 53).Invoice.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 53).Invoice.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 53).Invoice.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 53).Invoice.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 53).Invoice.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 53).Invoice.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 53).Invoice.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`$ (anyOf 53).Invoice.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 53).Invoice.Deposit`	JSON	Optional	The deposit made towards this invoice. Decimal string
`$ (anyOf 53).Invoice.Deposit (anyOf 1)`	number	Alternative
`$ (anyOf 53).Invoice.Deposit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 53).Invoice.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. Before you can use this field ensure that the company allows deposits in their invoices first. This can be found by querying the Preferences endpoint . SalesFormsPrefs.AllowDeposit must be equal to true. If you do not specify this account the payment is applied to the Undeposited Funds account.
`$ (anyOf 53).Invoice.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Conditionally required
`$ (anyOf 53).Invoice.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 53).Invoice.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 53).Invoice.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 53).Invoice.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 53).Invoice.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 53).Invoice.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 53).Invoice.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 53).Invoice.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 53).Invoice.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 53).Invoice.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 53).Invoice.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 53).Invoice.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 53).Invoice.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 53).Invoice.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 53).Invoice.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 53).Invoice.Id`	string	Required within parent
`$ (anyOf 53).Invoice.InvoiceLink`	string	Optional	Sharable link for the invoice sent to external customers. The link is generated only for invoices with online payment enabled and having a valid customer email address. Include query param `include=invoiceLink` to get the link back on query response. Read only: true
`$ (anyOf 53).Invoice.Line`	array	Optional	The minimum line item required for the request is one of the following. SalesItemLine , GroupLine and Inline subtotal using DescriptionOnlyLine
`$ (anyOf 53).Invoice.Line[]`	JSON	Each item
`$ (anyOf 53).Invoice.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 53).Invoice.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 53).Invoice.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 53).Invoice.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 53).Invoice.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 53).Invoice.LinkedTxn`	array	Optional	Zero or more related transactions to this Invoice object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this Invoice object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Progress Invoicing is not supported via the API. Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an Invoice object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 53).Invoice.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 53).Invoice.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 53).Invoice.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 53).Invoice.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Statement Memo field on the Invoice form in the QuickBooks Online UI.
`$ (anyOf 53).Invoice.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 53).Invoice.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Invoice was created from. Read only: true
`$ (anyOf 53).Invoice.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 53).Invoice.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 53).Invoice.ShipDate`	string	Optional	Date for delivery of goods or services.
`$ (anyOf 53).Invoice.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 53).Invoice.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 53).Invoice.SyncToken`	string	Required within parent
`$ (anyOf 53).Invoice.TaxExemptionRef`	JSON	Optional
`$ (anyOf 53).Invoice.TaxExemptionRef (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
`$ (anyOf 53).Invoice.TaxExemptionRef (anyOf 2)`	object	Alternative	Maximum fields: 0
`$ (anyOf 53).Invoice.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 53).Invoice.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 53).Invoice.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 53).Invoice.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`$ (anyOf 53).Invoice.TransactionLocationType`	string	Optional	The account location. For UAE, valid values include ABUDHABI AJMAN SHARJAH DUBAI FUJAIRAH RAS_AL_KHAIMAH UMM_AL_QUWAIN OTHER_GCC
`$ (anyOf 53).Invoice.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 53).Invoice.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 53).Invoice.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 53).Invoice.domain`	string	Optional
`$ (anyOf 53).Invoice.sparse`	boolean	Optional
`$ (anyOf 54)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 54).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 54).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 54).Invoice`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 54).Invoice.AllowIPNPayment`	JSON	Optional	Flag to allow payments from legacy Intuit Payment Network (IPN). Provided to maintain backward compatibility and must always be set to false . Do not modify
`$ (anyOf 54).Invoice.AllowIPNPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.AllowIPNPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.AllowOnlineACHPayment`	JSON	Optional	Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online bank transfers. The Bank transfer check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with ACH. If set to false , online bank transfers are not allowed. The Bank transfer check box is not checked on the QuickBooks UI for this invoice.
`$ (anyOf 54).Invoice.AllowOnlineACHPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.AllowOnlineACHPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.AllowOnlineAffirmPayment`	JSON	Optional	Specifies if online Affirm payments are allowed for this invoice and corresponds to the Affirm check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for Affirm with an ACTIVE subscription status. If set to true , allow invoice to be paid with online Affirm payments. The Affirm check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with Affirm. If set to false , online Affirm payments are not allowed. The Affirm check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`$ (anyOf 54).Invoice.AllowOnlineAffirmPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.AllowOnlineAffirmPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.AllowOnlineCreditCardPayment`	JSON	Optional	Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online credit card payments. The Credit card check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with credit cards. If set to false , online credit card payments are not allowed. The Credit card check box is not checked on the QuickBooks UI for this invoice.
`$ (anyOf 54).Invoice.AllowOnlineCreditCardPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.AllowOnlineCreditCardPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.AllowOnlinePayPalPayment`	JSON	Optional	Specifies if online PayPal/Venmo payments are allowed for this invoice and corresponds to the PayPal check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for PayPal with an ACTIVE subscription status. If set to true , allow invoice to be paid with online PayPal payments. The PayPal check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with PayPal. If set to false , online PayPal payments are not allowed. The PayPal check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`$ (anyOf 54).Invoice.AllowOnlinePayPalPayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.AllowOnlinePayPalPayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.AllowOnlinePayment`	JSON	Optional	Deprecated flag to allow online payments. In use before AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags existed and provided to maintain backward compatibility. If set to true , this invoice was created before AllowOnlinePayment was deprecated and denotes both CC and ACH payments are allowed. In addition, the AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags must be set to true . If set to false , this invoice was created after the AllowOnlinePayment flag was deprecated and is not used. Do not modify.
`$ (anyOf 54).Invoice.AllowOnlinePayment (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.AllowOnlinePayment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`$ (anyOf 54).Invoice.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked transaction against a specific transaction, the balance value won’t change. It will remain the same. Decimal string Read only: true
`$ (anyOf 54).Invoice.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 54).Invoice.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 54).Invoice.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. If you update the CustomerRef , the address passed using BillAddr will be honored.
`$ (anyOf 54).Invoice.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 54).Invoice.BillEmailBcc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the blind carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailBcc . If this email address is invalid, blind carbon copy email is not sent.
`$ (anyOf 54).Invoice.BillEmailCc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailCc . If this email address is invalid, carbon copy email is not sent.
`$ (anyOf 54).Invoice.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 54).Invoice.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Applicable if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 54).Invoice.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 54).Invoice.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 54).Invoice.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 54).Invoice.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 54).Invoice.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`$ (anyOf 54).Invoice.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 54).Invoice.Deposit`	JSON	Optional	The deposit made towards this invoice. Decimal string
`$ (anyOf 54).Invoice.Deposit (anyOf 1)`	number	Alternative
`$ (anyOf 54).Invoice.Deposit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 54).Invoice.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. Before you can use this field ensure that the company allows deposits in their invoices first. This can be found by querying the Preferences endpoint . SalesFormsPrefs.AllowDeposit must be equal to true. If you do not specify this account the payment is applied to the Undeposited Funds account.
`$ (anyOf 54).Invoice.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Conditionally required
`$ (anyOf 54).Invoice.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 54).Invoice.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 54).Invoice.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 54).Invoice.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 54).Invoice.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 54).Invoice.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 54).Invoice.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 54).Invoice.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 54).Invoice.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 54).Invoice.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 54).Invoice.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 54).Invoice.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 54).Invoice.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 54).Invoice.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 54).Invoice.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 54).Invoice.Id`	string	Required within parent
`$ (anyOf 54).Invoice.InvoiceLink`	string	Optional	Sharable link for the invoice sent to external customers. The link is generated only for invoices with online payment enabled and having a valid customer email address. Include query param `include=invoiceLink` to get the link back on query response. Read only: true
`$ (anyOf 54).Invoice.Line`	array	Optional	Individual line items of a transaction. Valid Line types include SalesItemLine , GroupLine , DescriptionOnlyLine (also used for inline Subtotal lines), DiscountLine and SubTotalLine (used for the overall transaction). If the transaction is taxable there is a limit of 750 lines per transaction.
`$ (anyOf 54).Invoice.Line[]`	JSON	Each item
`$ (anyOf 54).Invoice.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 54).Invoice.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 54).Invoice.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 54).Invoice.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 54).Invoice.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 54).Invoice.LinkedTxn`	array	Optional	Zero or more related transactions to this Invoice object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this Invoice object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Progress Invoicing is not supported via the API. Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an Invoice object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 54).Invoice.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 54).Invoice.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 54).Invoice.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 54).Invoice.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Statement Memo field on the Invoice form in the QuickBooks Online UI.
`$ (anyOf 54).Invoice.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 54).Invoice.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Invoice was created from. Read only: true
`$ (anyOf 54).Invoice.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 54).Invoice.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 54).Invoice.ShipDate`	string	Optional	Date for delivery of goods or services.
`$ (anyOf 54).Invoice.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 54).Invoice.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 54).Invoice.SyncToken`	string	Required within parent
`$ (anyOf 54).Invoice.TaxExemptionRef`	JSON	Optional
`$ (anyOf 54).Invoice.TaxExemptionRef (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
`$ (anyOf 54).Invoice.TaxExemptionRef (anyOf 2)`	object	Alternative	Maximum fields: 0
`$ (anyOf 54).Invoice.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 54).Invoice.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 54).Invoice.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 54).Invoice.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`$ (anyOf 54).Invoice.TransactionLocationType`	string	Optional	The account location. For UAE, valid values include ABUDHABI AJMAN SHARJAH DUBAI FUJAIRAH RAS_AL_KHAIMAH UMM_AL_QUWAIN OTHER_GCC
`$ (anyOf 54).Invoice.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 54).Invoice.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 54).Invoice.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 54).Invoice.domain`	string	Optional
`$ (anyOf 54).Invoice.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 55)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 55).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 55).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 55).Invoice`	Model	Required within parent	Expand Void an invoice — request body — body
`$ (anyOf 55).optionsData`	JSON	Required within parent	Must equal: void
`$ (anyOf 56)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 56).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 56).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 56).Item`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 56).Item.Active`	JSON	Optional	If true, the object is currently enabled for use by QuickBooks.
`$ (anyOf 56).Item.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 56).Item.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 56).Item.AssetAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name , respectively. Required for Inventory item types. Conditionally required
`$ (anyOf 56).Item.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class for the item. Query the Class name list resource to determine the appropriate object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 56).Item.CustomExtensions`	Model	Optional	Expand Create an item — request body — body Custom Extensions Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.
`$ (anyOf 56).Item.Description`	string	Optional	Description of the item.
`$ (anyOf 56).Item.ExpenseAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ExpenseAccountRef.value and ExpenseAccountRef.name , respectively. Required for Inventory , NonInventory , and Service item types.
`$ (anyOf 56).Item.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Item:SubItem . Returned from an existing object and not input on a new object.Limited to 5 levels. Read only: true
`$ (anyOf 56).Item.Id`	string	Optional	Unique Identifier for an Intuit entity (object). Required for the update operation. Read only: true
`$ (anyOf 56).Item.IncomeAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for IncomeAccountRef.value and IncomeAccountRef.name , respectively. Required for Inventory and Service item types.
`$ (anyOf 56).Item.InvStartDate`	string	Optional	Date of opening balance for the inventory transaction. For read operations, the date returned in this field is always the originally provided inventory start date. For update operations, the date supplied is interpreted as the inventory adjust date, is stored as such in the underlying data model, and is reflected in the QuickBooks Online UI for the object. The inventory adjust date is not exposed for read operations through the API. Required for Inventory type items. Conditionally required
`$ (anyOf 56).Item.Level`	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be the next level with respect to the parent. Limited to 5 levels. Read only: true
`$ (anyOf 56).Item.Level (anyOf 1)`	integer	Alternative
`$ (anyOf 56).Item.Level (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 56).Item.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 56).Item.Name`	string	Required within parent	Name of the category.
`$ (anyOf 56).Item.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The immediate parent of the sub item in the hierarchical Category:Sub-category list. If SubItem is true, then ParenRef is required. Query the Item name list resource to determine the appropriate object for this reference. Use Item.Id and Item.Name from that object for ParentRef.value and ParentRef.name , respectively. Conditionally required
`$ (anyOf 56).Item.PrefVendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the preferred vendor of this item. Query the Vendor name list resource to determine the appropriate object for this reference. Use Vendor.Id and Vendor.Name from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 56).Item.PurchaseCost`	JSON	Optional	Amount paid when buying or ordering the item, as expressed in the home currency. Decimal string
`$ (anyOf 56).Item.PurchaseCost (anyOf 1)`	number	Alternative
`$ (anyOf 56).Item.PurchaseCost (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 56).Item.PurchaseDesc`	string	Optional	Purchase description for the item.
`$ (anyOf 56).Item.PurchaseTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the purchase tax code for the item. Applicable to Service, Other Charge, and Product (Non-Inventory) item types. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for PurchaseTaxCodeRef.value and PurchaseTaxCodeRef.name , respectively.
`$ (anyOf 56).Item.PurchaseTaxIncluded`	JSON	Optional	True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.
`$ (anyOf 56).Item.PurchaseTaxIncluded (anyOf 1)`	boolean	Alternative
`$ (anyOf 56).Item.PurchaseTaxIncluded (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 56).Item.QtyOnHand`	JSON	Optional	Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items.Required for Inventory type items. Conditionally required Decimal string
`$ (anyOf 56).Item.QtyOnHand (anyOf 1)`	number	Alternative
`$ (anyOf 56).Item.QtyOnHand (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 56).Item.ReorderPoint`	JSON	Optional	The minimum quantity of a particular inventory item that you need to restock at any given time. The ReorderPoint value cannot be set to null for sparse updates(sparse=true). It can be set to null only for full updates. Decimal string
`$ (anyOf 56).Item.ReorderPoint (anyOf 1)`	number	Alternative
`$ (anyOf 56).Item.ReorderPoint (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 56).Item.SalesTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To For non-US companies only. Reference to the sales tax code for the Sales item. Applicable to Service and Sales item types only. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for SalesTaxCodeRef.value and SalesTaxCodeRef.name , respectively.
`$ (anyOf 56).Item.SalesTaxIncluded`	JSON	Optional	True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.
`$ (anyOf 56).Item.SalesTaxIncluded (anyOf 1)`	boolean	Alternative
`$ (anyOf 56).Item.SalesTaxIncluded (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 56).Item.Sku`	string	Optional	The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.
`$ (anyOf 56).Item.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 56).Item.SubItem`	JSON	Optional	true —The object is a sub-category. false —The object is a top-level category (default). Sub-categories can be nested to a maximum depth of three levels below a top-level category. Required for sub-category. Conditionally required
`$ (anyOf 56).Item.SubItem (anyOf 1)`	boolean	Alternative
`$ (anyOf 56).Item.SubItem (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 56).Item.SyncToken`	string	Optional	Version number of the entity. Required for the update operation. Read only: true
`$ (anyOf 56).Item.TaxClassificationRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Tax classification segregates different items into different classifications and the tax classification is one of the key parameters to determine appropriate tax on transactions involving items. Tax classifications are sourced by either tax governing authorities as in Malaysia or externally like Exactor. ‘Fuel’, ‘Garments’ and ‘Soft drinks’ are a few examples of tax classification in layman terms. User can choose a specific tax classification for an item while creating it. A level 1 tax classification cannot be associated to an Item.
`$ (anyOf 56).Item.Taxable`	JSON	Optional	If true, transactions for this item are taxable. Applicable to US companies, only.
`$ (anyOf 56).Item.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 56).Item.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 56).Item.TrackQtyOnHand`	JSON	Optional	True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type Inventory . Not applicable for Service or NonInventory item types.
`$ (anyOf 56).Item.TrackQtyOnHand (anyOf 1)`	boolean	Alternative
`$ (anyOf 56).Item.TrackQtyOnHand (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 56).Item.Type`	string	Required within parent	Must be set to the literal string, Category .
`$ (anyOf 56).Item.UnitPrice`	JSON	Optional	Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. Decimal string
`$ (anyOf 56).Item.UnitPrice (anyOf 1)`	number	Alternative
`$ (anyOf 56).Item.UnitPrice (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 56).Item.domain`	string	Optional
`$ (anyOf 56).Item.sparse`	boolean	Optional
`$ (anyOf 57)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 57).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 57).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 57).Item`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 57).Item.Active`	JSON	Optional	If true, the object is currently enabled for use by QuickBooks.
`$ (anyOf 57).Item.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 57).Item.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 57).Item.AssetAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Must be an account with account type of Other Current Asset . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name , respectively. Required for Inventory item types.
`$ (anyOf 57).Item.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class for the item. Query the Class name list resource to determine the appropriate object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 57).Item.CustomExtensions`	Model	Optional	Expand Create an item — request body — body Custom Extensions Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.
`$ (anyOf 57).Item.Description`	string	Optional	Description of the item.
`$ (anyOf 57).Item.ExpenseAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ExpenseAccountRef.value and ExpenseAccountRef.name , respectively. For France locales: This is an optional field. This is the purchase account id, If not provided it defaults to the default purchase account: 605100 and 601100 are the default expense accounts used for Service and Product type of item, respectively. Required for Inventory , NonInventory , and Service item types.
`$ (anyOf 57).Item.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Item:SubItem . Returned from an existing object and not input on a new object.Limited to 5 levels. Read only: true
`$ (anyOf 57).Item.Id`	string	Optional	Unique Identifier for an Intuit entity (object). Required for the update operation. Read only: true
`$ (anyOf 57).Item.IncomeAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for IncomeAccountRef.value and IncomeAccountRef.name , respectively. For France locales: This is an optional field. This is the sales account id, If not provided it defaults to the default sales account: 706100 and 707100 are the default expense accounts used for Service and Product type of item, respectively. Required for Inventory and Service item types. Conditionally required
`$ (anyOf 57).Item.InvStartDate`	string	Optional	Date of opening balance for the inventory transaction. Required when creating an Item.Type=Inventory . Required for Inventory item types.
`$ (anyOf 57).Item.Level`	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be the next level with respect to the parent. Limited to 5 levels. Read only: true
`$ (anyOf 57).Item.Level (anyOf 1)`	integer	Alternative
`$ (anyOf 57).Item.Level (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 57).Item.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 57).Item.Name`	string	Required within parent	Name of the item. This value must be unique, at least one character in length, and cannot include tabs, new lines, or colons. Required for create.
`$ (anyOf 57).Item.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The immediate parent of the sub item in the hierarchical Item:SubItem list. If SubItem is true, then ParenRef is required. If SubItem is true, then ParenRef is required. Query the Item name list resource to determine the appropriate object for this reference. Use Item.Id and Item.Name from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 57).Item.PrefVendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the preferred vendor of this item. Query the Vendor name list resource to determine the appropriate object for this reference. Use Vendor.Id and Vendor.Name from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 57).Item.PurchaseCost`	JSON	Optional	Amount paid when buying or ordering the item, as expressed in the home currency. Decimal string
`$ (anyOf 57).Item.PurchaseCost (anyOf 1)`	number	Alternative
`$ (anyOf 57).Item.PurchaseCost (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 57).Item.PurchaseDesc`	string	Optional	Purchase description for the item.
`$ (anyOf 57).Item.PurchaseTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the purchase tax code for the item. Applicable to Service, Other Charge, and Product (Non-Inventory) item types. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for PurchaseTaxCodeRef.value and PurchaseTaxCodeRef.name , respectively.
`$ (anyOf 57).Item.PurchaseTaxIncluded`	JSON	Optional	True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.
`$ (anyOf 57).Item.PurchaseTaxIncluded (anyOf 1)`	boolean	Alternative
`$ (anyOf 57).Item.PurchaseTaxIncluded (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 57).Item.QtyOnHand`	JSON	Optional	Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items.Required for Inventory type items. Conditionally required Decimal string
`$ (anyOf 57).Item.QtyOnHand (anyOf 1)`	number	Alternative
`$ (anyOf 57).Item.QtyOnHand (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 57).Item.ReorderPoint`	JSON	Optional	The minimum quantity of a particular inventory item that you need to restock at any given time. The ReorderPoint value cannot be set to null for sparse updates(sparse=true). It can be set to null only for full updates. Decimal string
`$ (anyOf 57).Item.ReorderPoint (anyOf 1)`	number	Alternative
`$ (anyOf 57).Item.ReorderPoint (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 57).Item.SalesTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To For non-US companies only. Reference to the sales tax code for the Sales item. Applicable to Service and Sales item types only. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for SalesTaxCodeRef.value and SalesTaxCodeRef.name , respectively.
`$ (anyOf 57).Item.SalesTaxIncluded`	JSON	Optional	True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.
`$ (anyOf 57).Item.SalesTaxIncluded (anyOf 1)`	boolean	Alternative
`$ (anyOf 57).Item.SalesTaxIncluded (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 57).Item.Sku`	string	Optional	The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.
`$ (anyOf 57).Item.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 57).Item.SubItem`	JSON	Optional	If true, this is a sub item. If false or null, this is a top-level item. Creating inventory hierarchies with traditional inventory items is being phased out in lieu of using categories and sub categories.
`$ (anyOf 57).Item.SubItem (anyOf 1)`	boolean	Alternative
`$ (anyOf 57).Item.SubItem (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 57).Item.SyncToken`	string	Optional	Version number of the entity. Required for the update operation. Read only: true
`$ (anyOf 57).Item.TaxClassificationRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Tax classification segregates different items into different classifications and the tax classification is one of the key parameters to determine appropriate tax on transactions involving items. Tax classifications are sourced by either tax governing authorities as in Malaysia or externally like Exactor. ‘Fuel’, ‘Garments’ and ‘Soft drinks’ are a few examples of tax classification in layman terms. User can choose a specific tax classification for an item while creating it. A level 1 tax classification cannot be associated to an Item.
`$ (anyOf 57).Item.Taxable`	JSON	Optional	If true, transactions for this item are taxable. Applicable to US companies, only.
`$ (anyOf 57).Item.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 57).Item.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 57).Item.TrackQtyOnHand`	JSON	Optional	True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type Inventory . Not applicable for Service or NonInventory item types.
`$ (anyOf 57).Item.TrackQtyOnHand (anyOf 1)`	boolean	Alternative
`$ (anyOf 57).Item.TrackQtyOnHand (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 57).Item.Type`	string	Optional	Classification that specifies the use of this item. See the description at the top of the Item entity page for details about supported item types. Used for goods the company sells and buys that are tracked as inventory. Service —Default setting when TrackQtyOnHand , InvStartDate , and AssetAccountRef are not specified. Used for non-tangible goods the company sells and buys that are not tracked as inventory. For example, specialized labor, consulting hours, and professional fees. This field is required to be explicitly set with one of the following: Inventory —Used for goods the company sells and buys that are tracked as inventory. Service —Used for non-tangible goods the company sells and buys that are not tracked as inventory. For example, specialized labor, consulting hours, and professional fees. NonInventory —Use for goods the company sells and buys that are not tracked as inventory. For example, office supplies or goods bought on behalf of the customer. . Conditionally required
`$ (anyOf 57).Item.UnitPrice`	JSON	Optional	Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. Decimal string
`$ (anyOf 57).Item.UnitPrice (anyOf 1)`	number	Alternative
`$ (anyOf 57).Item.UnitPrice (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 57).Item.domain`	string	Optional
`$ (anyOf 57).Item.sparse`	boolean	Optional
`$ (anyOf 58)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 58).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 58).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 58).Item`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 58).Item.Active`	JSON	Optional	If true, the object is currently enabled for use by QuickBooks.
`$ (anyOf 58).Item.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 58).Item.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 58).Item.AssetAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name , respectively. Required for Inventory item types. Conditionally required
`$ (anyOf 58).Item.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class for the item. Query the Class name list resource to determine the appropriate object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 58).Item.CustomExtensions`	Model	Optional	Expand Create an item — request body — body Custom Extensions Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.
`$ (anyOf 58).Item.Description`	string	Optional	Description of the item.
`$ (anyOf 58).Item.ExpenseAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ExpenseAccountRef.value and ExpenseAccountRef.name , respectively. Required for Inventory , NonInventory , and Service item types.
`$ (anyOf 58).Item.FullyQualifiedName`	string	Optional	Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Item:SubItem . Returned from an existing object and not input on a new object.Limited to 5 levels. Read only: true
`$ (anyOf 58).Item.Id`	string	Required within parent
`$ (anyOf 58).Item.IncomeAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income . Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for IncomeAccountRef.value and IncomeAccountRef.name , respectively. Required for Inventory and Service item types.
`$ (anyOf 58).Item.InvStartDate`	string	Optional	Date of opening balance for the inventory transaction. For read operations, the date returned in this field is always the originally provided inventory start date. For update operations, the date supplied is interpreted as the inventory adjust date, is stored as such in the underlying data model, and is reflected in the QuickBooks Online UI for the object. The inventory adjust date is not exposed for read operations through the API. Required for Inventory type items. Conditionally required
`$ (anyOf 58).Item.Level`	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be the next level with respect to the parent. Limited to 5 levels. Read only: true
`$ (anyOf 58).Item.Level (anyOf 1)`	integer	Alternative
`$ (anyOf 58).Item.Level (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 58).Item.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 58).Item.Name`	string	Optional	Name of the item. This value is unique.
`$ (anyOf 58).Item.ParentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The immediate parent of the sub item in the hierarchical Item:SubItem list. If SubItem is true, then ParenRef is required. If SubItem is true, then ParenRef is required. Query the Item name list resource to determine the appropriate object for this reference. Use Item.Id and Item.Name from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 58).Item.PrefVendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the preferred vendor of this item. Query the Vendor name list resource to determine the appropriate object for this reference. Use Vendor.Id and Vendor.Name from that object for ParentRef.value and ParentRef.name , respectively.
`$ (anyOf 58).Item.PurchaseCost`	JSON	Optional	Amount paid when buying or ordering the item, as expressed in the home currency. Decimal string
`$ (anyOf 58).Item.PurchaseCost (anyOf 1)`	number	Alternative
`$ (anyOf 58).Item.PurchaseCost (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 58).Item.PurchaseDesc`	string	Optional	Purchase description for the item.
`$ (anyOf 58).Item.PurchaseTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the purchase tax code for the item. Applicable to Service, Other Charge, and Product (Non-Inventory) item types. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for PurchaseTaxCodeRef.value and PurchaseTaxCodeRef.name , respectively.
`$ (anyOf 58).Item.PurchaseTaxIncluded`	JSON	Optional	True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.
`$ (anyOf 58).Item.PurchaseTaxIncluded (anyOf 1)`	boolean	Alternative
`$ (anyOf 58).Item.PurchaseTaxIncluded (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 58).Item.QtyOnHand`	JSON	Optional	Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items.Required for Inventory type items. Conditionally required Decimal string
`$ (anyOf 58).Item.QtyOnHand (anyOf 1)`	number	Alternative
`$ (anyOf 58).Item.QtyOnHand (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 58).Item.ReorderPoint`	JSON	Optional	The minimum quantity of a particular inventory item that you need to restock at any given time. The ReorderPoint value cannot be set to null for sparse updates(sparse=true). It can be set to null only for full updates. Decimal string
`$ (anyOf 58).Item.ReorderPoint (anyOf 1)`	number	Alternative
`$ (anyOf 58).Item.ReorderPoint (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 58).Item.SalesTaxCodeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To For non-US companies only. Reference to the sales tax code for the Sales item. Applicable to Service and Sales item types only. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for SalesTaxCodeRef.value and SalesTaxCodeRef.name , respectively.
`$ (anyOf 58).Item.SalesTaxIncluded`	JSON	Optional	True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.
`$ (anyOf 58).Item.SalesTaxIncluded (anyOf 1)`	boolean	Alternative
`$ (anyOf 58).Item.SalesTaxIncluded (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 58).Item.Sku`	string	Optional	The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.
`$ (anyOf 58).Item.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 58).Item.SubItem`	JSON	Optional	If true, this is a sub item. If false or null, this is a top-level item. Creating inventory hierarchies with traditional inventory items is being phased out in lieu of using categories and sub categories.
`$ (anyOf 58).Item.SubItem (anyOf 1)`	boolean	Alternative
`$ (anyOf 58).Item.SubItem (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 58).Item.SyncToken`	string	Required within parent
`$ (anyOf 58).Item.TaxClassificationRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Tax classification segregates different items into different classifications and the tax classification is one of the key parameters to determine appropriate tax on transactions involving items. Tax classifications are sourced by either tax governing authorities as in Malaysia or externally like Exactor. ‘Fuel’, ‘Garments’ and ‘Soft drinks’ are a few examples of tax classification in layman terms. User can choose a specific tax classification for an item while creating it. A level 1 tax classification cannot be associated to an Item.
`$ (anyOf 58).Item.Taxable`	JSON	Optional	If true, transactions for this item are taxable. Applicable to US companies, only.
`$ (anyOf 58).Item.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 58).Item.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 58).Item.TrackQtyOnHand`	JSON	Optional	True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type Inventory . Not applicable for Service or NonInventory item types.
`$ (anyOf 58).Item.TrackQtyOnHand (anyOf 1)`	boolean	Alternative
`$ (anyOf 58).Item.TrackQtyOnHand (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 58).Item.Type`	string	Optional	Classification that specifies the use of this item. See the description at the top of the Item entity page for details about supported item types. This field is required to be explicitly set with one of the following: Inventory —Used for goods the company sells and buys that are tracked as inventory. Service —Used for non-tangible goods the company sells and buys that are not tracked as inventory. For example, specialized labor, consulting hours, and professional fees. NonInventory —Use for goods the company sells and buys that are not tracked as inventory. For example, office supplies or goods bought on behalf of the customer. . Conditionally required
`$ (anyOf 58).Item.UnitPrice`	JSON	Optional	Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. Decimal string
`$ (anyOf 58).Item.UnitPrice (anyOf 1)`	number	Alternative
`$ (anyOf 58).Item.UnitPrice (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 58).Item.domain`	string	Optional
`$ (anyOf 58).Item.sparse`	boolean	Optional
`$ (anyOf 59)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 59).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 59).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 59).Item`	Model	Required within parent	Expand Update a category — request body — body
`$ (anyOf 60)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 60).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 60).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 60).JournalEntry`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 60).JournalEntry.Adjustment`	JSON	Optional	Indicates whether this transaction is a journal entry adjustment.
`$ (anyOf 60).JournalEntry.Adjustment (anyOf 1)`	boolean	Alternative
`$ (anyOf 60).JournalEntry.Adjustment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 60).JournalEntry.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 60).JournalEntry.DocNumber`	string	Optional	Reference number for the transaction. Throws an error when duplicate DocNumber is sent in the request and if Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default. If null value is sent in the request null will be saved. If there is a need to support assigning a docNumber when null, it can be achieved through include param, include=allowautodocnum
`$ (anyOf 60).JournalEntry.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 60).JournalEntry.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 60).JournalEntry.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 60).JournalEntry.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 60).JournalEntry.HomeTotalAmt`	JSON	Optional	The value of this field will always be set to zero. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 60).JournalEntry.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 60).JournalEntry.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 60).JournalEntry.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 60).JournalEntry.Line`	array	Required within parent	Individual line items of a journal entry. Two line items are required: one with PostingType set to Debit and one with PostingType set to Credit . Set Line.DetailType to JournalEntryLine for both lines.
`$ (anyOf 60).JournalEntry.Line[]`	Model	Each item	Expand Create a journalentry — request body — body Line item
`$ (anyOf 60).JournalEntry.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 60).JournalEntry.PrivateNote`	string	Optional	User entered, organization-private note about the transaction.
`$ (anyOf 60).JournalEntry.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the JournalEntry was created from. Read only: true
`$ (anyOf 60).JournalEntry.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 60).JournalEntry.TaxRateRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Tax Adjustment Rate Ids for this item. Query the TaxRate list resource to determine the appropriate TaxRate object for this reference. Use TaxRate.Id and TaxRate.Name from that object for TaxRateRef.value and TaxRateRef.name, respectively.
`$ (anyOf 60).JournalEntry.TotalAmt`	JSON	Optional	The value of this field will always be set to zero. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 60).JournalEntry.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 60).JournalEntry.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 60).JournalEntry.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 60).JournalEntry.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 60).JournalEntry.domain`	string	Optional
`$ (anyOf 60).JournalEntry.sparse`	boolean	Optional
`$ (anyOf 61)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 61).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 61).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 61).JournalEntry`	Model	Required within parent	Expand Delete a journalentry — request body — body
`$ (anyOf 62)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 62).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 62).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 62).JournalEntry`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 62).JournalEntry.Adjustment`	JSON	Optional	Indicates whether this transaction is a journal entry adjustment.
`$ (anyOf 62).JournalEntry.Adjustment (anyOf 1)`	boolean	Alternative
`$ (anyOf 62).JournalEntry.Adjustment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 62).JournalEntry.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 62).JournalEntry.DocNumber`	string	Optional	Reference number for the transaction. Throws an error when duplicate DocNumber is sent in the request and if Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default. If null value is sent in the request null will be saved. If there is a need to support assigning a docNumber when null, it can be achieved through include param, include=allowautodocnum
`$ (anyOf 62).JournalEntry.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 62).JournalEntry.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 62).JournalEntry.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 62).JournalEntry.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 62).JournalEntry.HomeTotalAmt`	JSON	Optional	The value of this field will always be set to zero. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 62).JournalEntry.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 62).JournalEntry.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 62).JournalEntry.Id`	string	Required within parent
`$ (anyOf 62).JournalEntry.Line`	array	Optional	Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Valid Line types include: JournalEntryLine and DescriptionOnlyLine
`$ (anyOf 62).JournalEntry.Line[]`	JSON	Each item
`$ (anyOf 62).JournalEntry.Line[] (anyOf 1)`	Model	Alternative	Expand Create a journalentry — request body — body Line item
`$ (anyOf 62).JournalEntry.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 62).JournalEntry.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 62).JournalEntry.PrivateNote`	string	Optional	User entered, organization-private note about the transaction.
`$ (anyOf 62).JournalEntry.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the JournalEntry was created from. Read only: true
`$ (anyOf 62).JournalEntry.SyncToken`	string	Required within parent
`$ (anyOf 62).JournalEntry.TaxRateRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Tax Adjustment Rate Ids for this item. Query the TaxRate list resource to determine the appropriate TaxRate object for this reference. Use TaxRate.Id and TaxRate.Name from that object for TaxRateRef.value and TaxRateRef.name, respectively.
`$ (anyOf 62).JournalEntry.TotalAmt`	JSON	Optional	The value of this field will always be set to zero. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 62).JournalEntry.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 62).JournalEntry.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 62).JournalEntry.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 62).JournalEntry.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 62).JournalEntry.domain`	string	Optional
`$ (anyOf 62).JournalEntry.sparse`	boolean	Optional
`$ (anyOf 63)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 63).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 63).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 63).JournalEntry`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 63).JournalEntry.Adjustment`	JSON	Optional	Indicates whether this transaction is a journal entry adjustment.
`$ (anyOf 63).JournalEntry.Adjustment (anyOf 1)`	boolean	Alternative
`$ (anyOf 63).JournalEntry.Adjustment (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 63).JournalEntry.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 63).JournalEntry.DocNumber`	string	Optional	Reference number for the transaction. Throws an error when duplicate DocNumber is sent in the request and if Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default. If null value is sent in the request null will be saved. If there is a need to support assigning a docNumber when null, it can be achieved through include param, include=allowautodocnum
`$ (anyOf 63).JournalEntry.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 63).JournalEntry.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 63).JournalEntry.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 63).JournalEntry.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 63).JournalEntry.HomeTotalAmt`	JSON	Optional	The value of this field will always be set to zero. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 63).JournalEntry.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 63).JournalEntry.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 63).JournalEntry.Id`	string	Required within parent
`$ (anyOf 63).JournalEntry.Line`	array	Optional	Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Valid Line types include: JournalEntryLine and DescriptionOnlyLine
`$ (anyOf 63).JournalEntry.Line[]`	JSON	Each item
`$ (anyOf 63).JournalEntry.Line[] (anyOf 1)`	Model	Alternative	Expand Create a journalentry — request body — body Line item
`$ (anyOf 63).JournalEntry.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 63).JournalEntry.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 63).JournalEntry.PrivateNote`	string	Optional	User entered, organization-private note about the transaction.
`$ (anyOf 63).JournalEntry.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the JournalEntry was created from. Read only: true
`$ (anyOf 63).JournalEntry.SyncToken`	string	Required within parent
`$ (anyOf 63).JournalEntry.TaxRateRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Tax Adjustment Rate Ids for this item. Query the TaxRate list resource to determine the appropriate TaxRate object for this reference. Use TaxRate.Id and TaxRate.Name from that object for TaxRateRef.value and TaxRateRef.name, respectively.
`$ (anyOf 63).JournalEntry.TotalAmt`	JSON	Optional	The value of this field will always be set to zero. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 63).JournalEntry.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 63).JournalEntry.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 63).JournalEntry.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 63).JournalEntry.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 63).JournalEntry.domain`	string	Optional
`$ (anyOf 63).JournalEntry.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 64)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 64).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 64).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 64).Payment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 64).Payment.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 64).Payment.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 64).Payment.CustomerRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 64).Payment.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this payment. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
`$ (anyOf 64).Payment.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company Decimal string
`$ (anyOf 64).Payment.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 64).Payment.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 64).Payment.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 64).Payment.Line`	array	Optional	Zero or more transactions accounting for this payment. Values for Line.LinkedTxn.TxnType can be one of the following: Expense —Payment is reimbursement for expense paid by cash made on behalf of the customer Check —Payment is reimbursement for expense paid by check made on behalf of the customer CreditCardCredit —Payment is reimbursement for a credit card credit made on behalf of the customer JournalEntry —Payment is linked to the representative journal entry CreditMemo —Payment is linked to the credit memo the customer has with the business Invoice —The invoice to which payment is applied Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 64).Payment.Line[]`	Model	Each item	Expand Void a payment — request body — body Line item
`$ (anyOf 64).Payment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 64).Payment.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 64).Payment.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation.
`$ (anyOf 64).Payment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction.
`$ (anyOf 64).Payment.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 64).Payment.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 64).Payment.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
`$ (anyOf 64).Payment.TotalAmt`	JSON	Required within parent	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Decimal string
`$ (anyOf 64).Payment.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 64).Payment.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 64).Payment.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 64).Payment.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 64).Payment.UnappliedAmt`	JSON	Optional	Indicates the amount that has not been applied to pay amounts owed for sales transactions. Decimal string Read only: true
`$ (anyOf 64).Payment.UnappliedAmt (anyOf 1)`	number	Alternative
`$ (anyOf 64).Payment.UnappliedAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 64).Payment.domain`	string	Optional
`$ (anyOf 64).Payment.sparse`	boolean	Optional
`$ (anyOf 64).Payment.ARAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To
`$ (anyOf 64).Payment.ProcessPayment`	boolean	Optional
`$ (anyOf 64).Payment.TxnStatus`	string	Optional
`$ (anyOf 64).Payment.TransactionLocationType`	string	Optional
`$ (anyOf 64).Payment.status`	string	Optional
`$ (anyOf 65)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 65).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 65).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 65).Payment`	Model	Required within parent	Expand Void a payment — request body — body
`$ (anyOf 66)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 66).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 66).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 66).Payment`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 66).Payment.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 66).Payment.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 66).Payment.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 66).Payment.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this payment. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
`$ (anyOf 66).Payment.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company Decimal string
`$ (anyOf 66).Payment.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 66).Payment.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 66).Payment.Id`	string	Required within parent
`$ (anyOf 66).Payment.Line`	array	Optional	Zero or more transactions accounting for this payment. Values for Line.LinkedTxn.TxnType can be one of the following: Expense —Payment is reimbursement for expense paid by cash made on behalf of the customer Check —Payment is reimbursement for expense paid by check made on behalf of the customer CreditCardCredit —Payment is reimbursement for a credit card credit made on behalf of the customer JournalEntry —Payment is linked to the representative journal entry CreditMemo —Payment is linked to the credit memo the customer has with the business Invoice —The invoice to which payment is applied Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 66).Payment.Line[]`	Model	Each item	Expand Void a payment — request body — body Line item
`$ (anyOf 66).Payment.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 66).Payment.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 66).Payment.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation.
`$ (anyOf 66).Payment.PrivateNote`	string	Optional	User entered, organization-private note about the transaction.
`$ (anyOf 66).Payment.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 66).Payment.SyncToken`	string	Required within parent
`$ (anyOf 66).Payment.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
`$ (anyOf 66).Payment.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to O. Decimal string
`$ (anyOf 66).Payment.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 66).Payment.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 66).Payment.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 66).Payment.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 66).Payment.UnappliedAmt`	JSON	Optional	Indicates the amount that has not been applied to pay amounts owed for sales transactions. Decimal string Read only: true
`$ (anyOf 66).Payment.UnappliedAmt (anyOf 1)`	number	Alternative
`$ (anyOf 66).Payment.UnappliedAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 66).Payment.domain`	string	Optional
`$ (anyOf 66).Payment.sparse`	boolean	Optional
`$ (anyOf 67)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 67).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 67).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 67).PaymentMethod`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 67).PaymentMethod.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 67).PaymentMethod.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 67).PaymentMethod.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 67).PaymentMethod.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 67).PaymentMethod.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 67).PaymentMethod.Name`	string	Required within parent	User recognizable name for the payment method.
`$ (anyOf 67).PaymentMethod.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 67).PaymentMethod.Type`	string	Optional	Defines the type of payment. Valid values include CREDIT_CARD or NON_CREDIT_CARD .
`$ (anyOf 67).PaymentMethod.domain`	string	Optional
`$ (anyOf 67).PaymentMethod.sparse`	boolean	Optional
`$ (anyOf 68)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 68).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 68).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 68).PaymentMethod`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 68).PaymentMethod.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 68).PaymentMethod.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 68).PaymentMethod.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 68).PaymentMethod.Id`	string	Required within parent
`$ (anyOf 68).PaymentMethod.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 68).PaymentMethod.Name`	string	Optional	User recognizable name for the payment method.
`$ (anyOf 68).PaymentMethod.SyncToken`	string	Required within parent
`$ (anyOf 68).PaymentMethod.Type`	string	Optional	Defines the type of payment. Valid values include CREDIT_CARD or NON_CREDIT_CARD .
`$ (anyOf 68).PaymentMethod.domain`	string	Optional
`$ (anyOf 68).PaymentMethod.sparse`	boolean	Optional
`$ (anyOf 69)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 69).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 69).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 69).Preferences`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 69).Preferences.AccountingInfoPrefs`	Model	Optional	Expand Full update preferences — request body — body Accounting Info Prefs The following settings are available for QuickBooks Online Plus editions, only. To determine this edition type, query the value of the OfferingSku CustomerInfo.Name name/value pair for QuickBooks Online Plus .
`$ (anyOf 69).Preferences.CurrencyPrefs`	Model	Optional	Expand Full update preferences — request body — body Currency Prefs
`$ (anyOf 69).Preferences.EmailMessagesPrefs`	Model	Optional	Expand Full update preferences — request body — body Email Messages Prefs
`$ (anyOf 69).Preferences.Id`	string	Required within parent
`$ (anyOf 69).Preferences.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 69).Preferences.OtherPrefs`	object	Optional	Specifies extension of Preference resource to allow extension of Name-Value pair based extension at the top level. Additional keys: allowed
`$ (anyOf 69).Preferences.ProductAndServicesPrefs`	Model	Optional	Expand Full update preferences — request body — body Product And Services Prefs
`$ (anyOf 69).Preferences.ReportPrefs`	Model	Optional	Expand Full update preferences — request body — body Report Prefs
`$ (anyOf 69).Preferences.SalesFormsPrefs`	Model	Optional	Expand Full update preferences — request body — body Sales Forms Prefs
`$ (anyOf 69).Preferences.SyncToken`	string	Required within parent
`$ (anyOf 69).Preferences.TaxPrefs`	Model	Optional	Expand Full update preferences — request body — body Tax Prefs
`$ (anyOf 69).Preferences.TimeTrackingPrefs`	Model	Optional	Expand Full update preferences — request body — body Time Tracking Prefs
`$ (anyOf 69).Preferences.VendorAndPurchasesPrefs`	Model	Optional	Expand Full update preferences — request body — body Vendor And Purchases Prefs
`$ (anyOf 69).Preferences.domain`	string	Optional
`$ (anyOf 69).Preferences.sparse`	boolean	Optional
`$ (anyOf 70)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 70).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 70).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 70).Purchase`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 70).Purchase.AccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Specifies the account reference. Check must specify bank account, CreditCard must specify credit card account. Validation Rules:Valid and Active Account Reference of an appropriate type.
`$ (anyOf 70).Purchase.Credit`	JSON	Optional	False —it represents a charge. True —it represents a refund. Valid only for CreditCard payment type. Validation Rules: Valid only for CreditCard transactions.
`$ (anyOf 70).Purchase.Credit (anyOf 1)`	boolean	Alternative
`$ (anyOf 70).Purchase.Credit (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 70).Purchase.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 70).Purchase.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 70).Purchase.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided; duplicate values are not accepted. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. For Cash/CreditCard transactions, throws an error when duplicate DocNumber is sent in the request. For Check transactions, error is thrown when duplicate DocNumber is sent in the request and Preferences:OtherPrefs:NameValue.Name = WarnDuplicateCheckNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 70).Purchase.EntityRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the party with whom an expense is associated. Can be Customer , Vendor, or Employee. Query the corresponding name list resource of the associated type to determine the appropriate object for this reference. Use the Id and DisplayName values from that object for EntityRef.value and EntityRef.name , respectively. Set EntityRef.type to the type of object associated with this expense. For example, if this object represents a purchase from a vendor, then set EntityRef.type to Vendor and query the Vendor resource for the appropriate object to reference.
`$ (anyOf 70).Purchase.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company Decimal string
`$ (anyOf 70).Purchase.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 70).Purchase.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 70).Purchase.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable .
`$ (anyOf 70).Purchase.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 70).Purchase.IncludeInAnnualTPAR`	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 70).Purchase.IncludeInAnnualTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 70).Purchase.IncludeInAnnualTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 70).Purchase.Line`	array	Required within parent	Individual line items of a transaction. Valid Line type for create: AccountBasedExpenseLine
`$ (anyOf 70).Purchase.Line[]`	Model	Each item	Expand Create a bill — request body — body Line item
`$ (anyOf 70).Purchase.LinkedTxn`	array	Optional	Zero or more transactions linked to this object. The LinkedTxn.TxnType can be set to ReimburseCharge . The LinkedTxn.TxnId can be set as the ID of the transaction.
`$ (anyOf 70).Purchase.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 70).Purchase.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 70).Purchase.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 70).Purchase.PaymentType`	string	Required within parent	Payment Type can be: Cash , Check , or CreditCard .
`$ (anyOf 70).Purchase.PrintStatus`	string	Optional	PrintStatus is applicable only for Check . Ignored for CreditCard charge or refund. Valid values: NotSet , NeedToPrint , PrintComplete.
`$ (anyOf 70).Purchase.PrivateNote`	string	Optional	User-entered, organization-private note about the transaction. This field maps to the Memo field on the Expense form in the QuickBooks UI.
`$ (anyOf 70).Purchase.PurchaseEx`	object	Optional	For internal use. Additional keys: allowed
`$ (anyOf 70).Purchase.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Purchase was created from. Read only: true
`$ (anyOf 70).Purchase.RemitToAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the payment should be sent. This attribute is applicable only for Check . Ignored for CreditCard charge or refund. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Read only: true
`$ (anyOf 70).Purchase.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 70).Purchase.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 70).Purchase.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 70).Purchase.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 70).Purchase.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 70).Purchase.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 70).Purchase.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 70).Purchase.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 70).Purchase.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 70).Purchase.domain`	string	Optional
`$ (anyOf 70).Purchase.sparse`	boolean	Optional
`$ (anyOf 71)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 71).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 71).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 71).Purchase`	Model	Required within parent	Expand Delete a purchase — request body — body
`$ (anyOf 72)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 72).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 72).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 72).Purchase`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 72).Purchase.AccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the account reference to which this purchase is applied based on the PaymentType . A type of Check should have bank account, CreditCard should specify credit card account, etc. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AccountRef.value and AccountRef.name , respectively.
`$ (anyOf 72).Purchase.Credit`	JSON	Optional	False —it represents a charge. True —it represents a refund. Valid only for CreditCard payment type. Validation Rules: Valid only for CreditCard transactions.
`$ (anyOf 72).Purchase.Credit (anyOf 1)`	boolean	Alternative
`$ (anyOf 72).Purchase.Credit (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 72).Purchase.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 72).Purchase.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 72).Purchase.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided; duplicate values are not accepted. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. For Cash/CreditCard transactions, throws an error when duplicate DocNumber is sent in the request. For Check transactions, error is thrown when duplicate DocNumber is sent in the request and Preferences:OtherPrefs:NameValue.Name = WarnDuplicateCheckNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 72).Purchase.EntityRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the party with whom an expense is associated. Can be Customer , Vendor, or Employee. Query the corresponding name list resource of the associated type to determine the appropriate object for this reference. Use the Id and DisplayName values from that object for EntityRef.value and EntityRef.name , respectively. Set EntityRef.type to the type of object associated with this expense. For example, if this object represents a purchase from a vendor, then set EntityRef.type to Vendor and query the Vendor resource for the appropriate object to reference.
`$ (anyOf 72).Purchase.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company Decimal string
`$ (anyOf 72).Purchase.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 72).Purchase.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 72).Purchase.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable .
`$ (anyOf 72).Purchase.Id`	string	Required within parent
`$ (anyOf 72).Purchase.IncludeInAnnualTPAR`	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 72).Purchase.IncludeInAnnualTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 72).Purchase.IncludeInAnnualTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 72).Purchase.Line`	array	Optional	Individual line items of a transaction. Valid Line types include ItemBasedExpenseLine (Available if Preferences.ProductAndServicesPrefs.ForPurchase is set to true ) and AccountBasedExpenseLine
`$ (anyOf 72).Purchase.Line[]`	JSON	Each item
`$ (anyOf 72).Purchase.Line[] (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Line item
`$ (anyOf 72).Purchase.Line[] (anyOf 2)`	Model	Alternative	Expand Create a bill — request body — body Line item
`$ (anyOf 72).Purchase.LinkedTxn`	array	Optional	Zero or more transactions linked to this object. The LinkedTxn.TxnType can be set to ReimburseCharge . The LinkedTxn.TxnId can be set as the ID of the transaction.
`$ (anyOf 72).Purchase.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 72).Purchase.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 72).Purchase.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 72).Purchase.PaymentType`	string	Optional	Type can be Cash , Check , or CreditCard .
`$ (anyOf 72).Purchase.PrintStatus`	string	Optional	PrintStatus is applicable only for Check . Ignored for CreditCard charge or refund. Valid values: NotSet , NeedToPrint , PrintComplete.
`$ (anyOf 72).Purchase.PrivateNote`	string	Optional	User-entered, organization-private note about the transaction. This field maps to the Memo field on the Expense form in the QuickBooks UI.
`$ (anyOf 72).Purchase.PurchaseEx`	object	Optional	For internal use. Additional keys: allowed
`$ (anyOf 72).Purchase.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Purchase was created from. Read only: true
`$ (anyOf 72).Purchase.RemitToAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the payment should be sent. This attribute is applicable only for Check . Ignored for CreditCard charge or refund. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Read only: true
`$ (anyOf 72).Purchase.SyncToken`	string	Required within parent
`$ (anyOf 72).Purchase.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 72).Purchase.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 72).Purchase.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 72).Purchase.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 72).Purchase.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 72).Purchase.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 72).Purchase.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 72).Purchase.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 72).Purchase.domain`	string	Optional
`$ (anyOf 72).Purchase.sparse`	boolean	Optional
`$ (anyOf 73)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 73).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 73).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 73).PurchaseOrder`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 73).PurchaseOrder.APAccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Specifies which AP account to which the bill is credited. Many/most small businesses have a single AP account, so the account can be implied. When specified, the account must be a Liability account, and further, the sub-type must be of type Payables. We strongly recommend that the AP Account be explicitly specified in all cases as companies that have more then one AP account will encounter unexpected errors when relating transactions to each other.
`$ (anyOf 73).PurchaseOrder.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 73).PurchaseOrder.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 73).PurchaseOrder.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 73).PurchaseOrder.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 73).PurchaseOrder.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 73).PurchaseOrder.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 73).PurchaseOrder.EmailStatus`	string	Optional	Email status of the purchase order. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 73).PurchaseOrder.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 73).PurchaseOrder.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 73).PurchaseOrder.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 73).PurchaseOrder.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 73).PurchaseOrder.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 73).PurchaseOrder.Line`	array	Required within parent	Individual line items of a transaction. Valid Line types include: Item line. Note: The ItemRef in the ItemBasedExpenseLine below must reference an Item in QBO that has an expense account linked to it (e.g. in the ExpenseAccountRef field of the Item). Otherwise the request fails in QBO with a ‘You must select an account for this transaction.’ error.
`$ (anyOf 73).PurchaseOrder.Line[]`	Model	Each item	Expand Create a purchase order — request body — body Line item
`$ (anyOf 73).PurchaseOrder.LinkedTxn`	array	Optional	Zero or more Bill objects linked to this purchase order; LinkedTxn.TxnType is set to Bill . To retrieve details of a linked Bill transaction, issue a separate request to read the Bill whose ID is linkedTxn.TxnId .
`$ (anyOf 73).PurchaseOrder.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 73).PurchaseOrder.Memo`	string	Optional	A message for the vendor. This text appears on the Purchase Order object sent to the vendor.
`$ (anyOf 73).PurchaseOrder.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 73).PurchaseOrder.POEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Used to specify the vendor e-mail address where the purchase req is sent.
`$ (anyOf 73).PurchaseOrder.POStatus`	string	Optional	Purchase order status. Valid values are: Open and Closed .
`$ (anyOf 73).PurchaseOrder.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the purchase order to the vendor. This field maps to the Memo field on the Purchase Order form.
`$ (anyOf 73).PurchaseOrder.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the PurchaseOrder was created from. Read only: true
`$ (anyOf 73).PurchaseOrder.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 73).PurchaseOrder.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the vendor shipped or will ship any goods associated with the purchase. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 73).PurchaseOrder.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the user-defined ShipMethod associated with the transaction. Store shipping method string in both ShipMethodRef.value and ShipMethodRef.name .
`$ (anyOf 73).PurchaseOrder.ShipTo`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the customer to whose shipping address the order will be shipped to.
`$ (anyOf 73).PurchaseOrder.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 73).PurchaseOrder.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 73).PurchaseOrder.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 73).PurchaseOrder.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 73).PurchaseOrder.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 73).PurchaseOrder.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 73).PurchaseOrder.VendorAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the payment should be sent. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 73).PurchaseOrder.VendorRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To The vendor reference for this transaction.
`$ (anyOf 73).PurchaseOrder.domain`	string	Optional
`$ (anyOf 73).PurchaseOrder.sparse`	boolean	Optional
`$ (anyOf 74)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 74).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 74).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 74).PurchaseOrder`	Model	Required within parent	Expand Delete a purchase order — request body — body
`$ (anyOf 75)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 75).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 75).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 75).PurchaseOrder`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 75).PurchaseOrder.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 75).PurchaseOrder.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 75).PurchaseOrder.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 75).PurchaseOrder.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 75).PurchaseOrder.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 75).PurchaseOrder.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 75).PurchaseOrder.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`$ (anyOf 75).PurchaseOrder.EmailStatus`	string	Optional	Email status of the purchase order. Valid values: NotSet , NeedToSend , EmailSent
`$ (anyOf 75).PurchaseOrder.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 75).PurchaseOrder.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 75).PurchaseOrder.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 75).PurchaseOrder.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 75).PurchaseOrder.Id`	string	Required within parent
`$ (anyOf 75).PurchaseOrder.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: ItemBasedExpenseLine and AccountBasedExpenseLine
`$ (anyOf 75).PurchaseOrder.Line[]`	JSON	Each item
`$ (anyOf 75).PurchaseOrder.Line[] (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Line item
`$ (anyOf 75).PurchaseOrder.Line[] (anyOf 2)`	Model	Alternative	Expand Create a bill — request body — body Line item
`$ (anyOf 75).PurchaseOrder.LinkedTxn`	array	Optional	Zero or more Bill objects linked to this purchase order; LinkedTxn.TxnType is set to Bill . To retrieve details of a linked Bill transaction, issue a separate request to read the Bill whose ID is linkedTxn.TxnId .
`$ (anyOf 75).PurchaseOrder.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 75).PurchaseOrder.Memo`	string	Optional	A message for the vendor. This text appears on the Purchase Order object sent to the vendor.
`$ (anyOf 75).PurchaseOrder.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 75).PurchaseOrder.POEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Used to specify the vendor e-mail address where the purchase req is sent.
`$ (anyOf 75).PurchaseOrder.POStatus`	string	Optional	Purchase order status. Valid values are: Open and Closed .
`$ (anyOf 75).PurchaseOrder.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the purchase order to the vendor. This field maps to the Memo field on the Purchase Order form.
`$ (anyOf 75).PurchaseOrder.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the PurchaseOrder was created from. Read only: true
`$ (anyOf 75).PurchaseOrder.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`$ (anyOf 75).PurchaseOrder.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the vendor shipped or will ship any goods associated with the purchase. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 75).PurchaseOrder.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the user-defined ShipMethod associated with the transaction. Store shipping method string in both ShipMethodRef.value and ShipMethodRef.name .
`$ (anyOf 75).PurchaseOrder.ShipTo`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the customer to whose shipping address the order will be shipped to.
`$ (anyOf 75).PurchaseOrder.SyncToken`	string	Required within parent
`$ (anyOf 75).PurchaseOrder.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 75).PurchaseOrder.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 75).PurchaseOrder.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 75).PurchaseOrder.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 75).PurchaseOrder.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 75).PurchaseOrder.VendorAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the payment should be sent. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 75).PurchaseOrder.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
`$ (anyOf 75).PurchaseOrder.domain`	string	Optional
`$ (anyOf 75).PurchaseOrder.sparse`	boolean	Optional
`$ (anyOf 76)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 76).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 76).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 76).RecurringTransaction`	object	Required within parent	Minimum fields: 1 Maximum fields: 1 Additional keys: not allowed
`$ (anyOf 76).RecurringTransaction.Bill`	Model	Optional	Expand Create a recurring transaction — request body — body Bill
`$ (anyOf 76).RecurringTransaction.Deposit`	Model	Optional	Expand Create a recurring transaction — request body — body Deposit
`$ (anyOf 76).RecurringTransaction.Estimate`	Model	Optional	Expand Create a recurring transaction — request body — body Estimate
`$ (anyOf 76).RecurringTransaction.Invoice`	Model	Optional	Expand Create a recurring transaction — request body — body Invoice
`$ (anyOf 76).RecurringTransaction.JournalEntry`	Model	Optional	Expand Create a recurring transaction — request body — body Journal Entry
`$ (anyOf 76).RecurringTransaction.Purchase`	Model	Optional	Expand Create a recurring transaction — request body — body Purchase
`$ (anyOf 76).RecurringTransaction.RefundReceipt`	Model	Optional	Expand Create a recurring transaction — request body — body Refund Receipt
`$ (anyOf 76).RecurringTransaction.SalesReceipt`	Model	Optional	Expand Create a recurring transaction — request body — body Sales Receipt
`$ (anyOf 76).RecurringTransaction.Transfer`	Model	Optional	Expand Create a recurring transaction — request body — body Transfer
`$ (anyOf 76).RecurringTransaction.VendorCredit`	Model	Optional	Expand Create a recurring transaction — request body — body Vendor Credit
`$ (anyOf 77)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 77).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 77).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 77).RecurringTransaction`	Model	Required within parent	Expand Delete a recurring transaction — request body — body
`$ (anyOf 78)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 78).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 78).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 78).RefundReceipt`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 78).RefundReceipt.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. Default Value: false Constraints: US versions of QuickBooks only.
`$ (anyOf 78).RefundReceipt.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 78).RefundReceipt.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 78).RefundReceipt.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 78).RefundReceipt.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 78).RefundReceipt.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 78).RefundReceipt.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 78).RefundReceipt.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 78).RefundReceipt.CheckPayment`	Model	Optional	Expand Create a refund receipt — request body — body Check Payment Information about a check payment for the transaction. Used when PaymentType is Check .
`$ (anyOf 78).RefundReceipt.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 78).RefundReceipt.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Used when PaymentType is CreditCard . Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 78).RefundReceipt.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 78).RefundReceipt.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 78).RefundReceipt.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 78).RefundReceipt.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transaction.
`$ (anyOf 78).RefundReceipt.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 78).RefundReceipt.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 78).RefundReceipt.DepositToAccountRef`	JSON	Required within parent	Accounts receivable asset account from which payment money is refunded. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. CurrencyRefType Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here .
`$ (anyOf 78).RefundReceipt.DepositToAccountRef (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Ship To
`$ (anyOf 78).RefundReceipt.DepositToAccountRef (anyOf 2)`	Model	Alternative	Expand Create a bill — request body — body Currency Ref
`$ (anyOf 78).RefundReceipt.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. Recommended best practice: check the setting of Preferences:CustomTxnNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. Sort order is ASC by default.
`$ (anyOf 78).RefundReceipt.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 78).RefundReceipt.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 78).RefundReceipt.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 78).RefundReceipt.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 78).RefundReceipt.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Applicable if multicurrency is enabled for the company Decimal string Read only: true
`$ (anyOf 78).RefundReceipt.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 78).RefundReceipt.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 78).RefundReceipt.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 78).RefundReceipt.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 78).RefundReceipt.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 78).RefundReceipt.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 78).RefundReceipt.Line`	array	Required within parent	The minimum line item required for the request is one of the following: SalesItemLine and GroupLine
`$ (anyOf 78).RefundReceipt.Line[]`	JSON	Each item
`$ (anyOf 78).RefundReceipt.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 78).RefundReceipt.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 78).RefundReceipt.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 78).RefundReceipt.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 78).RefundReceipt.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 78).RefundReceipt.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 78).RefundReceipt.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, check # for a check, envelope # for a cash donation. Provide when DepositToAccountRef references an Account object where Account.AccountType=Bank . Required when PrintStatus is set to PrintComplete . If PrintStatus is set to NeedToPrint , the system sets PaymentRefNum to To Print . Conditionally required
`$ (anyOf 78).RefundReceipt.PaymentType`	string	Optional	Valid values are Cash , Check , CreditCard , or Other .
`$ (anyOf 78).RefundReceipt.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 78).RefundReceipt.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the refund receipt to the customer. This field maps to the Memo field on the refund receipt form.
`$ (anyOf 78).RefundReceipt.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 78).RefundReceipt.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the RefundReceipt was created from. Read only: true
`$ (anyOf 78).RefundReceipt.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 78).RefundReceipt.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 78).RefundReceipt.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 78).RefundReceipt.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 78).RefundReceipt.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 78).RefundReceipt.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 78).RefundReceipt.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 78).RefundReceipt.TxnSource`	string	Optional	The originating source of the credit card transaction. Used in eCommerce apps where credit card transactions are processed by a merchant account. When set to IntuitPayment , this transaction is inserted into a list of pending deposits to be automatically matched and reconciled with the merchant’s account when the transactions made via QuickBooks Payments settle. Currently, the only supported value is IntuitPayment .
`$ (anyOf 78).RefundReceipt.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 78).RefundReceipt.domain`	string	Optional
`$ (anyOf 78).RefundReceipt.sparse`	boolean	Optional
`$ (anyOf 79)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 79).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 79).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 79).RefundReceipt`	Model	Required within parent	Expand Delete a refund receipt — request body — body
`$ (anyOf 80)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 80).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 80).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 80).RefundReceipt`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 80).RefundReceipt.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. Default Value: false Constraints: US versions of QuickBooks only.
`$ (anyOf 80).RefundReceipt.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 80).RefundReceipt.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 80).RefundReceipt.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 80).RefundReceipt.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 80).RefundReceipt.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 80).RefundReceipt.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 80).RefundReceipt.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 80).RefundReceipt.CheckPayment`	Model	Optional	Expand Create a refund receipt — request body — body Check Payment Information about a check payment for the transaction. Used when PaymentType is Check .
`$ (anyOf 80).RefundReceipt.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 80).RefundReceipt.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Used when PaymentType is CreditCard . Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 80).RefundReceipt.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 80).RefundReceipt.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 80).RefundReceipt.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 80).RefundReceipt.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transaction.
`$ (anyOf 80).RefundReceipt.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 80).RefundReceipt.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 80).RefundReceipt.DepositToAccountRef`	JSON	Optional	Accounts receivable asset account from which payment money is refunded. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. CurrencyRefType Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here .
`$ (anyOf 80).RefundReceipt.DepositToAccountRef (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Ship To
`$ (anyOf 80).RefundReceipt.DepositToAccountRef (anyOf 2)`	Model	Alternative	Expand Create a bill — request body — body Currency Ref
`$ (anyOf 80).RefundReceipt.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. Recommended best practice: check the setting of Preferences:CustomTxnNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. Sort order is ASC by default.
`$ (anyOf 80).RefundReceipt.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 80).RefundReceipt.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 80).RefundReceipt.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 80).RefundReceipt.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 80).RefundReceipt.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Applicable if multicurrency is enabled for the company Decimal string Read only: true
`$ (anyOf 80).RefundReceipt.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 80).RefundReceipt.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 80).RefundReceipt.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 80).RefundReceipt.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 80).RefundReceipt.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 80).RefundReceipt.Id`	string	Required within parent
`$ (anyOf 80).RefundReceipt.Line`	array	Optional	The minimum line item required for the request is one of the following: SalesItemLine and GroupLine
`$ (anyOf 80).RefundReceipt.Line[]`	JSON	Each item
`$ (anyOf 80).RefundReceipt.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 80).RefundReceipt.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 80).RefundReceipt.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 80).RefundReceipt.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 80).RefundReceipt.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 80).RefundReceipt.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 80).RefundReceipt.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, check # for a check, envelope # for a cash donation. Provide when DepositToAccountRef references an Account object where Account.AccountType=Bank . Required when PrintStatus is set to PrintComplete . If PrintStatus is set to NeedToPrint , the system sets PaymentRefNum to To Print . Conditionally required
`$ (anyOf 80).RefundReceipt.PaymentType`	string	Optional	Valid values are Cash , Check , CreditCard , or Other .
`$ (anyOf 80).RefundReceipt.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 80).RefundReceipt.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the refund receipt to the customer. This field maps to the Memo field on the refund receipt form.
`$ (anyOf 80).RefundReceipt.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 80).RefundReceipt.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the RefundReceipt was created from. Read only: true
`$ (anyOf 80).RefundReceipt.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 80).RefundReceipt.SyncToken`	string	Required within parent
`$ (anyOf 80).RefundReceipt.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 80).RefundReceipt.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 80).RefundReceipt.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 80).RefundReceipt.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 80).RefundReceipt.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 80).RefundReceipt.TxnSource`	string	Optional	The originating source of the credit card transaction. Used in eCommerce apps where credit card transactions are processed by a merchant account. When set to IntuitPayment , this transaction is inserted into a list of pending deposits to be automatically matched and reconciled with the merchant’s account when the transactions made via QuickBooks Payments settle. Currently, the only supported value is IntuitPayment .
`$ (anyOf 80).RefundReceipt.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 80).RefundReceipt.domain`	string	Optional
`$ (anyOf 80).RefundReceipt.sparse`	boolean	Optional
`$ (anyOf 81)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 81).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 81).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 81).RefundReceipt`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 81).RefundReceipt.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. Default Value: false Constraints: US versions of QuickBooks only.
`$ (anyOf 81).RefundReceipt.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 81).RefundReceipt.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 81).RefundReceipt.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 81).RefundReceipt.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 81).RefundReceipt.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 81).RefundReceipt.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 81).RefundReceipt.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`$ (anyOf 81).RefundReceipt.CheckPayment`	Model	Optional	Expand Create a refund receipt — request body — body Check Payment Information about a check payment for the transaction. Used when PaymentType is Check .
`$ (anyOf 81).RefundReceipt.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 81).RefundReceipt.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Used when PaymentType is CreditCard . Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 81).RefundReceipt.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
`$ (anyOf 81).RefundReceipt.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 81).RefundReceipt.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 81).RefundReceipt.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transaction.
`$ (anyOf 81).RefundReceipt.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 81).RefundReceipt.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 81).RefundReceipt.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account from which payment money is refunded. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively.
`$ (anyOf 81).RefundReceipt.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. Recommended best practice: check the setting of Preferences:CustomTxnNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. Sort order is ASC by default.
`$ (anyOf 81).RefundReceipt.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 81).RefundReceipt.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 81).RefundReceipt.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 81).RefundReceipt.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 81).RefundReceipt.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Applicable if multicurrency is enabled for the company Decimal string Read only: true
`$ (anyOf 81).RefundReceipt.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 81).RefundReceipt.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 81).RefundReceipt.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 81).RefundReceipt.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 81).RefundReceipt.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 81).RefundReceipt.Id`	string	Required within parent
`$ (anyOf 81).RefundReceipt.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine , DiscountLine and SubTotalLine (read-only)
`$ (anyOf 81).RefundReceipt.Line[]`	JSON	Each item
`$ (anyOf 81).RefundReceipt.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 81).RefundReceipt.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 81).RefundReceipt.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 81).RefundReceipt.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 81).RefundReceipt.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 81).RefundReceipt.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 81).RefundReceipt.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 81).RefundReceipt.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, check # for a check, envelope # for a cash donation. Provide when DepositToAccountRef references an Account object where Account.AccountType=Bank . Required when PrintStatus is set to PrintComplete . If PrintStatus is set to NeedToPrint , the system sets PaymentRefNum to To Print . Conditionally required
`$ (anyOf 81).RefundReceipt.PaymentType`	string	Optional	Valid values are Cash , Check , CreditCard , or Other .
`$ (anyOf 81).RefundReceipt.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 81).RefundReceipt.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the refund receipt to the customer. This field maps to the Memo field on the refund receipt form.
`$ (anyOf 81).RefundReceipt.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 81).RefundReceipt.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the RefundReceipt was created from. Read only: true
`$ (anyOf 81).RefundReceipt.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 81).RefundReceipt.SyncToken`	string	Required within parent
`$ (anyOf 81).RefundReceipt.TaxExemptionRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
`$ (anyOf 81).RefundReceipt.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 81).RefundReceipt.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 81).RefundReceipt.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 81).RefundReceipt.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 81).RefundReceipt.TxnSource`	string	Optional	The originating source of the credit card transaction. Used in eCommerce apps where credit card transactions are processed by a merchant account. When set to IntuitPayment , this transaction is inserted into a list of pending deposits to be automatically matched and reconciled with the merchant’s account when the transactions made via QuickBooks Payments settle. Currently, the only supported value is IntuitPayment .
`$ (anyOf 81).RefundReceipt.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 81).RefundReceipt.domain`	string	Optional
`$ (anyOf 81).RefundReceipt.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 82)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 82).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 82).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 82).SalesReceipt`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 82).SalesReceipt.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. Default Value: false Constraints: US versions of QuickBooks only.
`$ (anyOf 82).SalesReceipt.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 82).SalesReceipt.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 82).SalesReceipt.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 82).SalesReceipt.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 82).SalesReceipt.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 82).SalesReceipt.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 82).SalesReceipt.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. Required if EmailStatus=NeedToSend Conditionally required
`$ (anyOf 82).SalesReceipt.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 82).SalesReceipt.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Used when PaymentType is CreditCard . Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 82).SalesReceipt.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 82).SalesReceipt.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 82).SalesReceipt.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 82).SalesReceipt.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 82).SalesReceipt.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 82).SalesReceipt.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`$ (anyOf 82).SalesReceipt.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 82).SalesReceipt.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which payment money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
`$ (anyOf 82).SalesReceipt.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 82).SalesReceipt.EmailStatus`	string	Optional	Email status of the receipt. Valid values: NotSet , NeedToSend , EmailSent .
`$ (anyOf 82).SalesReceipt.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 82).SalesReceipt.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 82).SalesReceipt.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 82).SalesReceipt.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 82).SalesReceipt.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 82).SalesReceipt.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 82).SalesReceipt.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 82).SalesReceipt.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 82).SalesReceipt.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 82).SalesReceipt.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 82).SalesReceipt.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company Decimal string Read only: true
`$ (anyOf 82).SalesReceipt.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 82).SalesReceipt.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 82).SalesReceipt.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 82).SalesReceipt.Line`	array	Required within parent	The minimum line item required for the request is one of the following: SalesItemLine and GroupLine
`$ (anyOf 82).SalesReceipt.Line[]`	JSON	Each item
`$ (anyOf 82).SalesReceipt.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 82).SalesReceipt.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 82).SalesReceipt.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 82).SalesReceipt.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 82).SalesReceipt.LinkedTxn`	array	Optional	Zero or more related transactions to this sales receipt object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this sales receipt object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an sales receipt object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links the sales receipt to refundReceipt objects that are applied to the sales receipt. Returned in the response if linkedTxnTxnType is a refundReceipt. Note that linking sales receipts to refund receipts can only be done via the customer-facing QuickBooks UI. This is only available as read-only via our API Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 82).SalesReceipt.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 82).SalesReceipt.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 82).SalesReceipt.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 82).SalesReceipt.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, Â Check # for a check, envelope # for a cash donation.
`$ (anyOf 82).SalesReceipt.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 82).SalesReceipt.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the transaction form to the customer. This field maps to the Memo field on the Sales Receipt form.
`$ (anyOf 82).SalesReceipt.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 82).SalesReceipt.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the SalesReceipt was created from. Read only: true
`$ (anyOf 82).SalesReceipt.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 82).SalesReceipt.ShipDate`	string	Optional	Location of the transaction, as defined using location tracking in QuickBooks Online.
`$ (anyOf 82).SalesReceipt.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 82).SalesReceipt.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 82).SalesReceipt.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 82).SalesReceipt.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to O. Decimal string Read only: true
`$ (anyOf 82).SalesReceipt.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 82).SalesReceipt.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 82).SalesReceipt.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`$ (anyOf 82).SalesReceipt.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 82).SalesReceipt.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 82).SalesReceipt.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This element provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 82).SalesReceipt.domain`	string	Optional
`$ (anyOf 82).SalesReceipt.sparse`	boolean	Optional
`$ (anyOf 83)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 83).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 83).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 83).SalesReceipt`	Model	Required within parent	Expand Void a salesreceipt — request body — body
`$ (anyOf 84)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 84).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 84).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 84).SalesReceipt`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 84).SalesReceipt.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. Default Value: false Constraints: US versions of QuickBooks only.
`$ (anyOf 84).SalesReceipt.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 84).SalesReceipt.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 84).SalesReceipt.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 84).SalesReceipt.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 84).SalesReceipt.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 84).SalesReceipt.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 84).SalesReceipt.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. Required if EmailStatus=NeedToSend Conditionally required
`$ (anyOf 84).SalesReceipt.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 84).SalesReceipt.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Used when PaymentType is CreditCard . Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 84).SalesReceipt.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 84).SalesReceipt.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 84).SalesReceipt.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 84).SalesReceipt.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 84).SalesReceipt.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 84).SalesReceipt.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`$ (anyOf 84).SalesReceipt.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 84).SalesReceipt.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which payment money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
`$ (anyOf 84).SalesReceipt.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 84).SalesReceipt.EmailStatus`	string	Optional	Email status of the receipt. Valid values: NotSet , NeedToSend , EmailSent .
`$ (anyOf 84).SalesReceipt.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 84).SalesReceipt.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 84).SalesReceipt.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 84).SalesReceipt.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 84).SalesReceipt.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 84).SalesReceipt.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 84).SalesReceipt.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 84).SalesReceipt.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 84).SalesReceipt.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 84).SalesReceipt.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 84).SalesReceipt.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company Decimal string Read only: true
`$ (anyOf 84).SalesReceipt.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 84).SalesReceipt.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 84).SalesReceipt.Id`	string	Required within parent
`$ (anyOf 84).SalesReceipt.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine , DiscountLine and SubTotalLine (read-only). If the transaction is taxable there is a limit of 750 lines per transaction.
`$ (anyOf 84).SalesReceipt.Line[]`	JSON	Each item
`$ (anyOf 84).SalesReceipt.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 84).SalesReceipt.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 84).SalesReceipt.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 84).SalesReceipt.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 84).SalesReceipt.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 84).SalesReceipt.LinkedTxn`	array	Optional	Zero or more related transactions to this sales receipt object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this sales receipt object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an sales receipt object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links the sales receipt to refundReceipt objects that are applied to the sales receipt. Returned in the response if linkedTxnTxnType is a refundReceipt. Note that linking sales receipts to refund receipts can only be done via the customer-facing QuickBooks UI. This is only available as read-only via our API Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 84).SalesReceipt.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 84).SalesReceipt.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 84).SalesReceipt.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 84).SalesReceipt.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, Â Check # for a check, envelope # for a cash donation.
`$ (anyOf 84).SalesReceipt.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 84).SalesReceipt.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the transaction form to the customer. This field maps to the Memo field on the Sales Receipt form.
`$ (anyOf 84).SalesReceipt.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 84).SalesReceipt.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the SalesReceipt was created from. Read only: true
`$ (anyOf 84).SalesReceipt.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 84).SalesReceipt.ShipDate`	string	Optional	Location of the transaction, as defined using location tracking in QuickBooks Online.
`$ (anyOf 84).SalesReceipt.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 84).SalesReceipt.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 84).SalesReceipt.SyncToken`	string	Required within parent
`$ (anyOf 84).SalesReceipt.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to O. Decimal string Read only: true
`$ (anyOf 84).SalesReceipt.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 84).SalesReceipt.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 84).SalesReceipt.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`$ (anyOf 84).SalesReceipt.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 84).SalesReceipt.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 84).SalesReceipt.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This element provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 84).SalesReceipt.domain`	string	Optional
`$ (anyOf 84).SalesReceipt.sparse`	boolean	Optional
`$ (anyOf 85)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 85).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 85).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 85).SalesReceipt`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 85).SalesReceipt.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. Default Value: false Constraints: US versions of QuickBooks only.
`$ (anyOf 85).SalesReceipt.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`$ (anyOf 85).SalesReceipt.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 85).SalesReceipt.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 85).SalesReceipt.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 85).SalesReceipt.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 85).SalesReceipt.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 85).SalesReceipt.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. Required if EmailStatus=NeedToSend Conditionally required
`$ (anyOf 85).SalesReceipt.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 85).SalesReceipt.CreditCardPayment`	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Used when PaymentType is CreditCard . Inject with data only if the payment was transacted through Intuit Payments API.
`$ (anyOf 85).SalesReceipt.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 85).SalesReceipt.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`$ (anyOf 85).SalesReceipt.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`$ (anyOf 85).SalesReceipt.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`$ (anyOf 85).SalesReceipt.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 85).SalesReceipt.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`$ (anyOf 85).SalesReceipt.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 85).SalesReceipt.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which payment money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
`$ (anyOf 85).SalesReceipt.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
`$ (anyOf 85).SalesReceipt.EmailStatus`	string	Optional	Email status of the receipt. Valid values: NotSet , NeedToSend , EmailSent .
`$ (anyOf 85).SalesReceipt.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 85).SalesReceipt.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 85).SalesReceipt.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 85).SalesReceipt.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`$ (anyOf 85).SalesReceipt.FreeFormAddress (anyOf 1)`	boolean	Alternative
`$ (anyOf 85).SalesReceipt.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 85).SalesReceipt.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 85).SalesReceipt.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`$ (anyOf 85).SalesReceipt.HomeBalance (anyOf 1)`	number	Alternative
`$ (anyOf 85).SalesReceipt.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 85).SalesReceipt.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company Decimal string Read only: true
`$ (anyOf 85).SalesReceipt.HomeTotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 85).SalesReceipt.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 85).SalesReceipt.Id`	string	Required within parent
`$ (anyOf 85).SalesReceipt.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine , DiscountLine and SubTotalLine (read-only). If the transaction is taxable there is a limit of 750 lines per transaction.
`$ (anyOf 85).SalesReceipt.Line[]`	JSON	Each item
`$ (anyOf 85).SalesReceipt.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`$ (anyOf 85).SalesReceipt.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`$ (anyOf 85).SalesReceipt.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`$ (anyOf 85).SalesReceipt.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`$ (anyOf 85).SalesReceipt.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`$ (anyOf 85).SalesReceipt.LinkedTxn`	array	Optional	Zero or more related transactions to this sales receipt object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this sales receipt object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an sales receipt object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links the sales receipt to refundReceipt objects that are applied to the sales receipt. Returned in the response if linkedTxnTxnType is a refundReceipt. Note that linking sales receipts to refund receipts can only be done via the customer-facing QuickBooks UI. This is only available as read-only via our API Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`$ (anyOf 85).SalesReceipt.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 85).SalesReceipt.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 85).SalesReceipt.PaymentMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
`$ (anyOf 85).SalesReceipt.PaymentRefNum`	string	Optional	The reference number for the payment received. For example, Â Check # for a check, envelope # for a cash donation.
`$ (anyOf 85).SalesReceipt.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`$ (anyOf 85).SalesReceipt.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the transaction form to the customer. This field maps to the Memo field on the Sales Receipt form.
`$ (anyOf 85).SalesReceipt.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 85).SalesReceipt.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the SalesReceipt was created from. Read only: true
`$ (anyOf 85).SalesReceipt.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 85).SalesReceipt.ShipDate`	string	Optional	Location of the transaction, as defined using location tracking in QuickBooks Online.
`$ (anyOf 85).SalesReceipt.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`$ (anyOf 85).SalesReceipt.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`$ (anyOf 85).SalesReceipt.SyncToken`	string	Required within parent
`$ (anyOf 85).SalesReceipt.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to O. Decimal string Read only: true
`$ (anyOf 85).SalesReceipt.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 85).SalesReceipt.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 85).SalesReceipt.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`$ (anyOf 85).SalesReceipt.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 85).SalesReceipt.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`$ (anyOf 85).SalesReceipt.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This element provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`$ (anyOf 85).SalesReceipt.domain`	string	Optional
`$ (anyOf 85).SalesReceipt.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 86)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 86).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 86).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 86).TaxAgency`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 86).TaxAgency.DisplayName`	string	Required within parent	Name of the agency.
`$ (anyOf 86).TaxAgency.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 86).TaxAgency.LastFileDate`	string	Optional	The last tax filing date for this tax agency. This field is automatically populated by QuickBooks business logic at tax filing time. Read only: true
`$ (anyOf 86).TaxAgency.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 86).TaxAgency.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 86).TaxAgency.TaxAgencyConfig`	string	Optional	Flag to identify whether the TaxAgency is system defined by Automated Sales Tax engine or user generated. Valid values include USER_DEFINED , SYSTEM_GENERATED SYSTEM_GENERATED. Read only: true
`$ (anyOf 86).TaxAgency.TaxRegistrationNumber`	string	Optional	Registration number for the agency. Read only: true
`$ (anyOf 86).TaxAgency.TaxTrackedOnPurchases`	JSON	Optional	Denotes whether this tax agency is used to track tax on purchases. Read only: true
`$ (anyOf 86).TaxAgency.TaxTrackedOnPurchases (anyOf 1)`	boolean	Alternative
`$ (anyOf 86).TaxAgency.TaxTrackedOnPurchases (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 86).TaxAgency.TaxTrackedOnSales`	JSON	Optional	Denotes whether this tax agency is used to track tax on sales. Read only: true
`$ (anyOf 86).TaxAgency.TaxTrackedOnSales (anyOf 1)`	boolean	Alternative
`$ (anyOf 86).TaxAgency.TaxTrackedOnSales (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 86).TaxAgency.domain`	string	Optional
`$ (anyOf 86).TaxAgency.sparse`	boolean	Optional
`$ (anyOf 87)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 87).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 87).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 87).Term`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 87).Term.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 87).Term.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 87).Term.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 87).Term.DayOfMonthDue`	JSON	Optional	Payment must be received by this day of the month. Required if DueDays not present Conditionally required
`$ (anyOf 87).Term.DayOfMonthDue (anyOf 1)`	integer	Alternative
`$ (anyOf 87).Term.DayOfMonthDue (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 87).Term.DiscountDayOfMonth`	JSON	Optional	Discount applies if paid before this day of month. Required if DueDays not present Minimum: 1
`$ (anyOf 87).Term.DiscountDayOfMonth (anyOf 1)`	integer	Alternative
`$ (anyOf 87).Term.DiscountDayOfMonth (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 87).Term.DiscountDays`	JSON	Optional	Discount applies if paid within this number of days. Used only when DueDays is specified.
`$ (anyOf 87).Term.DiscountDays (anyOf 1)`	integer	Alternative
`$ (anyOf 87).Term.DiscountDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 87).Term.DiscountPercent`	JSON	Optional	Discount percentage available against an amount if paid within the days specified by DiscountDays . Decimal string
`$ (anyOf 87).Term.DiscountPercent (anyOf 1)`	number	Alternative
`$ (anyOf 87).Term.DiscountPercent (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 87).Term.DueDays`	JSON	Optional	Number of days from delivery of goods or services until the payment is due. Required if DayOfMonthDue not present Conditionally required
`$ (anyOf 87).Term.DueDays (anyOf 1)`	integer	Alternative
`$ (anyOf 87).Term.DueDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 87).Term.DueNextMonthDays`	JSON	Optional	Payment due next month if issued that many days before the DayOfMonthDue . Required if DueDays not present. Minimum: 1
`$ (anyOf 87).Term.DueNextMonthDays (anyOf 1)`	integer	Alternative
`$ (anyOf 87).Term.DueNextMonthDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 87).Term.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 87).Term.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 87).Term.Name`	string	Required within parent	User recognizable name for the term. For example, Net 30 .
`$ (anyOf 87).Term.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 87).Term.Type`	string	Optional	Type of the Sales Term. Valid values: STANDARD —Used if DueDays is not null. DATE_DRIVEN —Used if DueDays is null.
`$ (anyOf 87).Term.domain`	string	Optional
`$ (anyOf 87).Term.sparse`	boolean	Optional
`$ (anyOf 88)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 88).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 88).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 88).Term`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 88).Term.Active`	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
`$ (anyOf 88).Term.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 88).Term.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 88).Term.DayOfMonthDue`	JSON	Optional	Payment must be received by this day of the month. Required if DueDays not present Conditionally required
`$ (anyOf 88).Term.DayOfMonthDue (anyOf 1)`	integer	Alternative
`$ (anyOf 88).Term.DayOfMonthDue (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 88).Term.DiscountDayOfMonth`	JSON	Optional	Discount applies if paid before this day of month. Required if DueDays not present Minimum: 1
`$ (anyOf 88).Term.DiscountDayOfMonth (anyOf 1)`	integer	Alternative
`$ (anyOf 88).Term.DiscountDayOfMonth (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 88).Term.DiscountDays`	JSON	Optional	Discount applies if paid within this number of days. Used only when DueDays is specified.
`$ (anyOf 88).Term.DiscountDays (anyOf 1)`	integer	Alternative
`$ (anyOf 88).Term.DiscountDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 88).Term.DiscountPercent`	JSON	Optional	Discount percentage available against an amount if paid within the days specified by DiscountDays . Decimal string
`$ (anyOf 88).Term.DiscountPercent (anyOf 1)`	number	Alternative
`$ (anyOf 88).Term.DiscountPercent (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 88).Term.DueDays`	JSON	Optional	Number of days from delivery of goods or services until the payment is due. Required if DayOfMonthDue not present Conditionally required
`$ (anyOf 88).Term.DueDays (anyOf 1)`	integer	Alternative
`$ (anyOf 88).Term.DueDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 88).Term.DueNextMonthDays`	JSON	Optional	Payment due next month if issued that many days before the DayOfMonthDue . Required if DueDays not present. Minimum: 1
`$ (anyOf 88).Term.DueNextMonthDays (anyOf 1)`	integer	Alternative
`$ (anyOf 88).Term.DueNextMonthDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 88).Term.Id`	string	Required within parent
`$ (anyOf 88).Term.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 88).Term.Name`	string	Optional	User recognizable name for the term. For example, Net 30 .
`$ (anyOf 88).Term.SyncToken`	string	Required within parent
`$ (anyOf 88).Term.Type`	string	Optional	Type of the Sales Term. Valid values: STANDARD —Used if DueDays is not null. DATE_DRIVEN —Used if DueDays is null.
`$ (anyOf 88).Term.domain`	string	Optional
`$ (anyOf 88).Term.sparse`	boolean	Optional
`$ (anyOf 89)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 89).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 89).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 89).TimeActivity`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 89).TimeActivity.BillableStatus`	string	Optional	Billable status of the time recorded. This field is not updatable through an API request. The value automatically changes when an invoice is created. Valid values: Billable , NotBillable , HasBeenBilled . You cannot directly update the status to HasBeenBilled . To set the status to HasBeenBilled , create an Invoice object and attach this TimeActivity object as a linked transaction to that Invoice. Read only: true
`$ (anyOf 89).TimeActivity.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with this object. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 89).TimeActivity.CostRate`	JSON	Optional	Pay rate of the employee or vendor for this time activity. Decimal string
`$ (anyOf 89).TimeActivity.CostRate (anyOf 1)`	number	Alternative
`$ (anyOf 89).TimeActivity.CostRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 89).TimeActivity.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`$ (anyOf 89).TimeActivity.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of this object. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 89).TimeActivity.Description`	string	Optional	Description of work completed during time activity.
`$ (anyOf 89).TimeActivity.EmployeeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the employee whose time is being recorded. Query the Employee name list resource to determine the appropriate Employee object for this reference. Use Employee.Id and Employee.DisplayName from that object for EmployeerRef.value and EmployeeRef.Name , respectively.
`$ (anyOf 89).TimeActivity.EndTime`	string	Optional	Time that work ends. Required if Hours and Minutes not specified. Note: Kindly consider only the Hours without including the timeZone offset as it does not impact time activity hours calculation. If TnxDate is provided then consider passing the StartTime and EndTime wihtout including the timeZone offset, then the the date passed on the TxnDate is used. If TnxDate is NOT provided, passing the StartTime and EndTime with/wihtout including the timeZone offset, then the the current date on the server is used. For any transactions with historical/future dates kindly include TxnDate in YYYY-MM-DD format and StartTime and EndTime in Hours and Minutes Conditionally required
`$ (anyOf 89).TimeActivity.HourlyRate`	JSON	Optional	Hourly bill rate of the employee or vendor for this time activity. Required if BillableStatus is set to Billable Conditionally required Decimal string
`$ (anyOf 89).TimeActivity.HourlyRate (anyOf 1)`	number	Alternative
`$ (anyOf 89).TimeActivity.HourlyRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 89).TimeActivity.Hours`	JSON	Optional	Hours and minutes worked. Required if StartTime and EndTime not specified Conditionally required
`$ (anyOf 89).TimeActivity.Hours (anyOf 1)`	integer	Alternative
`$ (anyOf 89).TimeActivity.Hours (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 89).TimeActivity.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 89).TimeActivity.ItemRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the service item associated with this object. Query the Item name list resource, where Item.Type is set to Service , to determine the appropriate Item object for this reference. Use Item.Id and Item.Name from that object for ItemRef.value and ItemRef.name , respectively. For France locales: The account associated with the referenced Item object is looked up in the account category list. If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then the item account is used. If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account.
`$ (anyOf 89).TimeActivity.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 89).TimeActivity.NameOf`	string	Required within parent	Enumeration of time activity types. Required in conjunction with either EmployeeRef or VendorRef attributes for create operations. Valid values: Vendor or Employee .
`$ (anyOf 89).TimeActivity.PayrollItemRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies how much the employee should be paid for doing the work specified by the Compensation Id. Query the EmployeeCompensation resource to determine the appropriate PayrollCompensation object for an employee. Use EmployeeCompensation.Id and EmployerCompensation.Name from that object for PayrollItemRef.value and PayrollItemRef.name , respectively. This field is available as part of the Payroll Compensation resource in the Workforce API. Read more about the Payroll Compensation resource , available to Silver, Gold, and Platinum partners.
`$ (anyOf 89).TimeActivity.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 89).TimeActivity.StartTime`	string	Optional	Time that work starts. Required if Hours and Minutes not specified. Note: Kindly consider only the Hours without including the timeZone offset as it does not impact time activity hours calculation. If TnxDate is provided then consider passing the StartTime and EndTime wihtout including the timeZone offset, then the the date passed on the TxnDate is used. If TnxDate is NOT provided, passing the StartTime and EndTime with/wihtout including the timeZone offset, then the the current date on the server is used. For any transactions with historical/future dates kindly include TxnDate in YYYY-MM-DD format and StartTime and EndTime in Hours and Minutes Conditionally required
`$ (anyOf 89).TimeActivity.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 89).TimeActivity.Taxable`	JSON	Optional	True if the time recorded is both billable and taxable.
`$ (anyOf 89).TimeActivity.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 89).TimeActivity.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 89).TimeActivity.TxnDate`	string	Optional	The date for the time activity. This is the posting date that affects financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default. If you provide the StartTime and EndTime without including the timeZone offset, then you would need to pass the TxnDate for any historical or future dates. Lets say if you want to create a historical time activity then pass the TxnDate as the date and pass StartTime and EndTime as Hours without including the timeZone offset. Conditionally required
`$ (anyOf 89).TimeActivity.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the vendor whose time is being recorded. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively. Conditionally required
`$ (anyOf 89).TimeActivity.Minutes`	JSON	Optional	Hours and minutes worked. Required if StartTime and EndTime not specified Conditionally required
`$ (anyOf 89).TimeActivity.Minutes (anyOf 1)`	integer	Alternative
`$ (anyOf 89).TimeActivity.Minutes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 89).TimeActivity.BreakHours`	JSON	Optional	Hours and minutes of break taken between StartTime and EndTime . use when StartTime and EndTime are specified Conditionally required
`$ (anyOf 89).TimeActivity.BreakHours (anyOf 1)`	integer	Alternative
`$ (anyOf 89).TimeActivity.BreakHours (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 89).TimeActivity.BreakMinutes`	JSON	Optional	Hours and minutes of break taken between StartTime and EndTime . use when StartTime and EndTime are specified Conditionally required
`$ (anyOf 89).TimeActivity.BreakMinutes (anyOf 1)`	integer	Alternative
`$ (anyOf 89).TimeActivity.BreakMinutes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 89).TimeActivity.domain`	string	Optional
`$ (anyOf 89).TimeActivity.sparse`	boolean	Optional
`$ (anyOf 90)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 90).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 90).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 90).TimeActivity`	Model	Required within parent	Expand Delete a timeactivity object — request body — body
`$ (anyOf 91)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 91).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 91).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 91).TimeActivity`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 91).TimeActivity.BillableStatus`	string	Optional	Billable status of the time recorded. This field is not updatable through an API request. The value automatically changes when an invoice is created. Valid values: Billable , NotBillable , HasBeenBilled . You cannot directly update the status to HasBeenBilled . To set the status to HasBeenBilled , create an Invoice object and attach this TimeActivity object as a linked transaction to that Invoice. Read only: true
`$ (anyOf 91).TimeActivity.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with this object. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`$ (anyOf 91).TimeActivity.CostRate`	JSON	Optional	Pay rate of the employee or vendor for this time activity. Decimal string
`$ (anyOf 91).TimeActivity.CostRate (anyOf 1)`	number	Alternative
`$ (anyOf 91).TimeActivity.CostRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 91).TimeActivity.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively. Required if BillableStatus is set to Billable Conditionally required
`$ (anyOf 91).TimeActivity.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of this object. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 91).TimeActivity.Description`	string	Optional	Description of work completed during time activity.
`$ (anyOf 91).TimeActivity.EmployeeRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the employee whose time is being recorded. Query the Employee name list resource to determine the appropriate Employee object for this reference. Use Employee.Id and Employee.DisplayName from that object for EmployeerRef.value and EmployeeRef.Name , respectively. Required if NameOf is set to Employee Conditionally required
`$ (anyOf 91).TimeActivity.EndTime`	string	Optional	Time that work starts and ends, respectively. Required if Hours and Minutes not specified. Note: Kindly consider only the Hours without including the timeZone offset as it does not impact time activity hours calculation. Conditionally required
`$ (anyOf 91).TimeActivity.HourlyRate`	JSON	Optional	Hourly bill rate of the employee or vendor for this time activity. Required if BillableStatus is set to Billable Conditionally required Decimal string
`$ (anyOf 91).TimeActivity.HourlyRate (anyOf 1)`	number	Alternative
`$ (anyOf 91).TimeActivity.HourlyRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 91).TimeActivity.Hours`	JSON	Optional	Hours and minutes worked. Required if StartTime and EndTime not specified Conditionally required
`$ (anyOf 91).TimeActivity.Hours (anyOf 1)`	integer	Alternative
`$ (anyOf 91).TimeActivity.Hours (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 91).TimeActivity.Id`	string	Required within parent
`$ (anyOf 91).TimeActivity.ItemRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the service item associated with this object. Query the Item name list resource, where Item.Type is set to Service , to determine the appropriate Item object for this reference. Use Item.Id and Item.Name from that object for ItemRef.value and ItemRef.name , respectively. For France locales: The account associated with the referenced Item object is looked up in the account category list. If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then the item account is used. If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account.
`$ (anyOf 91).TimeActivity.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 91).TimeActivity.NameOf`	string	Optional	Enumeration of time activity types. Required in conjunction with either EmployeeRef or VendorRef attributes for create operations. Valid values: Vendor or Employee .
`$ (anyOf 91).TimeActivity.PayrollItemRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies how much the employee should be paid for doing the work specified by the Compensation Id. Query the EmployeeCompensation resource to determine the appropriate PayrollCompensation object for an employee. Use EmployeeCompensation.Id and EmployerCompensation.Name from that object for PayrollItemRef.value and PayrollItemRef.name , respectively. This field is available as part of the Payroll Compensation resource in the Workforce API. Read more about the Payroll Compensation resource , available to Silver, Gold, and Platinum partners.
`$ (anyOf 91).TimeActivity.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`$ (anyOf 91).TimeActivity.StartTime`	string	Optional	Time that work starts and ends, respectively. Required if Hours and Minutes not specified. Note: Kindly consider only the Hours without including the timeZone offset as it does not impact time activity hours calculation. Conditionally required
`$ (anyOf 91).TimeActivity.SyncToken`	string	Required within parent
`$ (anyOf 91).TimeActivity.Taxable`	JSON	Optional	True if the time recorded is both billable and taxable.
`$ (anyOf 91).TimeActivity.Taxable (anyOf 1)`	boolean	Alternative
`$ (anyOf 91).TimeActivity.Taxable (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 91).TimeActivity.TxnDate`	string	Optional	The date for the time activity. This is the posting date that affects financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default. If you provide the StartTime and EndTime without including the timeZone offset, then you would need to pass the TxnDate for any historical or future dates. Lets say if you want to create a historical time activity then pass the TxnDate as the date and pass StartTime and EndTime as Hours without including the timeZone offset. Conditionally required
`$ (anyOf 91).TimeActivity.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the vendor whose time is being recorded. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively. Required if NameOf is set to Vendor Conditionally required
`$ (anyOf 91).TimeActivity.Minutes`	JSON	Optional	Hours and minutes worked. Required if StartTime and EndTime not specified Conditionally required
`$ (anyOf 91).TimeActivity.Minutes (anyOf 1)`	integer	Alternative
`$ (anyOf 91).TimeActivity.Minutes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 91).TimeActivity.BreakHours`	JSON	Optional	Hours and minutes of break taken between StartTime and EndTime . use when StartTime and EndTime are specified Conditionally required
`$ (anyOf 91).TimeActivity.BreakHours (anyOf 1)`	integer	Alternative
`$ (anyOf 91).TimeActivity.BreakHours (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 91).TimeActivity.BreakMinutes`	JSON	Optional	Hours and minutes of break taken between StartTime and EndTime . use when StartTime and EndTime are specified Conditionally required
`$ (anyOf 91).TimeActivity.BreakMinutes (anyOf 1)`	integer	Alternative
`$ (anyOf 91).TimeActivity.BreakMinutes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+$
`$ (anyOf 91).TimeActivity.domain`	string	Optional
`$ (anyOf 91).TimeActivity.sparse`	boolean	Optional
`$ (anyOf 92)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 92).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 92).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 92).Transfer`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 92).Transfer.Amount`	JSON	Required within parent	Indicates the total amount of the transaction. Decimal string
`$ (anyOf 92).Transfer.Amount (anyOf 1)`	number	Alternative
`$ (anyOf 92).Transfer.Amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 92).Transfer.FromAccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Identifies the asset account from which funds are transfered. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for FromAccountRef.value and FromAccountRef.name , respectively. The specified account must have Account.Classification set to Asset .
`$ (anyOf 92).Transfer.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 92).Transfer.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 92).Transfer.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 92).Transfer.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Transfer was created from. Read only: true
`$ (anyOf 92).Transfer.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 92).Transfer.ToAccountRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Identifies the asset account to which funds are transfered. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ToAccountRef.value and ToAccountRef.name , respectively. The specified account must have Account.Classification set to Asset .
`$ (anyOf 92).Transfer.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 92).Transfer.domain`	string	Optional
`$ (anyOf 92).Transfer.sparse`	boolean	Optional
`$ (anyOf 93)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 93).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 93).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 93).Transfer`	Model	Required within parent	Expand Delete an transfer — request body — body
`$ (anyOf 94)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 94).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 94).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 94).Transfer`	Model	Required within parent	Expand Delete an transfer — request body — body
`$ (anyOf 95)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 95).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 95).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 95).Transfer`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 95).Transfer.Amount`	JSON	Optional	Indicates the total amount of the transaction. Decimal string
`$ (anyOf 95).Transfer.Amount (anyOf 1)`	number	Alternative
`$ (anyOf 95).Transfer.Amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 95).Transfer.FromAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the asset account from which funds are transfered. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for FromAccountRef.value and FromAccountRef.name , respectively. The specified account must have Account.Classification set to Asset .
`$ (anyOf 95).Transfer.Id`	string	Required within parent
`$ (anyOf 95).Transfer.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 95).Transfer.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form.
`$ (anyOf 95).Transfer.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Transfer was created from. Read only: true
`$ (anyOf 95).Transfer.SyncToken`	string	Required within parent
`$ (anyOf 95).Transfer.ToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the asset account to which funds are transfered. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ToAccountRef.value and ToAccountRef.name , respectively. The specified account must have Account.Classification set to Asset .
`$ (anyOf 95).Transfer.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 95).Transfer.domain`	string	Optional
`$ (anyOf 95).Transfer.sparse`	boolean	Required within parent	Must equal: true
`$ (anyOf 96)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 96).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 96).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 96).Vendor`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 96).Vendor.AcctNum`	string	Optional	Name or number of the account associated with this vendor.
`$ (anyOf 96).Vendor.Active`	JSON	Optional	If true, this object is currently enabled for use by QuickBooks.
`$ (anyOf 96).Vendor.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 96).Vendor.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 96).Vendor.AlternatePhone`	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
`$ (anyOf 96).Vendor.Balance`	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create, read-only otherwise. Decimal string Read only: true
`$ (anyOf 96).Vendor.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 96).Vendor.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 96).Vendor.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 96).Vendor.BillRate`	JSON	Optional	BillRate can be set to specify this vendor’s hourly billing rate. Decimal string
`$ (anyOf 96).Vendor.BillRate (anyOf 1)`	number	Alternative
`$ (anyOf 96).Vendor.BillRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 96).Vendor.CompanyName`	string	Optional	The name of the company associated with the person or organization.
`$ (anyOf 96).Vendor.CostRate`	JSON	Optional	Pay rate of the vendor Decimal string
`$ (anyOf 96).Vendor.CostRate (anyOf 1)`	number	Alternative
`$ (anyOf 96).Vendor.CostRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 96).Vendor.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts associated with this vendor are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this vendor is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read-only after object is created. Read only: true
`$ (anyOf 96).Vendor.DisplayName`	string	Optional	The name of the vendor as displayed. Must be unique across all Vendor, Customer, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating vendor name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix .
`$ (anyOf 96).Vendor.FamilyName`	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 96).Vendor.Fax`	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
`$ (anyOf 96).Vendor.GivenName`	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 96).Vendor.HasTPAR`	JSON	Optional	Indicate if the vendor has TPAR enabled. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 96).Vendor.HasTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 96).Vendor.HasTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 96).Vendor.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 96).Vendor.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 96).Vendor.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 96).Vendor.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 96).Vendor.OtherContactInfo`	Model	Optional	Expand Create a vendor — request body — body Other Contact Info List of ContactInfo entities of any contact info type.
`$ (anyOf 96).Vendor.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 96).Vendor.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 96).Vendor.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName . Cannot be removed with sparse update.
`$ (anyOf 96).Vendor.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 96).Vendor.Suffix`	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 96).Vendor.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 96).Vendor.T4AEligible`	JSON	Optional	True if vendor is T4A eligible. Valid for CA locale
`$ (anyOf 96).Vendor.T4AEligible (anyOf 1)`	boolean	Alternative
`$ (anyOf 96).Vendor.T4AEligible (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 96).Vendor.T5018Eligible`	JSON	Optional	True if vendor is T5018 eligible. Valid for CA locale
`$ (anyOf 96).Vendor.T5018Eligible (anyOf 1)`	boolean	Alternative
`$ (anyOf 96).Vendor.T5018Eligible (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 96).Vendor.TaxIdentifier`	string	Optional	The tax ID of the Person or Organization. The value is masked in responses, exposing only last four characters. For example, the ID of 123-45-6789 is returned as XXXXXXX6789 .
`$ (anyOf 96).Vendor.TermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a default Term associated with this Vendor object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for TermRef.value and TermRef.name , respectively.
`$ (anyOf 96).Vendor.Title`	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , Suffix , or FullyQualifiedName attributes are required during create. Conditionally required
`$ (anyOf 96).Vendor.Vendor1099`	JSON	Optional	This vendor is an independent contractor; someone who is given a 1099-MISC form at the end of the year. A 1099 vendor is paid with regular checks, and taxes are not withheld on their behalf.
`$ (anyOf 96).Vendor.Vendor1099 (anyOf 1)`	boolean	Alternative
`$ (anyOf 96).Vendor.Vendor1099 (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 96).Vendor.VendorPaymentBankDetail`	Model	Optional	Expand Create a vendor — request body — body Vendor Payment Bank Detail Vendor Payment Bank Detail.
`$ (anyOf 96).Vendor.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 96).Vendor.domain`	string	Optional
`$ (anyOf 96).Vendor.sparse`	boolean	Optional
`$ (anyOf 97)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 97).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 97).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 97).Vendor`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 97).Vendor.AcctNum`	string	Optional	Name or number of the account associated with this vendor.
`$ (anyOf 97).Vendor.Active`	JSON	Optional	If true, this object is currently enabled for use by QuickBooks.
`$ (anyOf 97).Vendor.Active (anyOf 1)`	boolean	Alternative
`$ (anyOf 97).Vendor.Active (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 97).Vendor.AlternatePhone`	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
`$ (anyOf 97).Vendor.Balance`	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create, read-only otherwise. Decimal string Read only: true
`$ (anyOf 97).Vendor.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 97).Vendor.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 97).Vendor.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`$ (anyOf 97).Vendor.BillRate`	JSON	Optional	BillRate can be set to specify this vendor’s hourly billing rate. Decimal string
`$ (anyOf 97).Vendor.BillRate (anyOf 1)`	number	Alternative
`$ (anyOf 97).Vendor.BillRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 97).Vendor.CompanyName`	string	Optional	The name of the company associated with the person or organization.
`$ (anyOf 97).Vendor.CostRate`	JSON	Optional	Pay rate of the vendor Decimal string
`$ (anyOf 97).Vendor.CostRate (anyOf 1)`	number	Alternative
`$ (anyOf 97).Vendor.CostRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 97).Vendor.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts associated with this vendor are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this vendor is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read-only after object is created. Read only: true
`$ (anyOf 97).Vendor.DisplayName`	string	Optional	The name of the vendor as displayed. Must be unique across all Vendor, Customer, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating vendor name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix .
`$ (anyOf 97).Vendor.FamilyName`	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 97).Vendor.Fax`	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
`$ (anyOf 97).Vendor.GivenName`	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 97).Vendor.HasTPAR`	JSON	Optional	Indicate if the vendor has TPAR enabled. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 97).Vendor.HasTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 97).Vendor.HasTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 97).Vendor.Id`	string	Required within parent
`$ (anyOf 97).Vendor.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 97).Vendor.MiddleName`	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 97).Vendor.Mobile`	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
`$ (anyOf 97).Vendor.OtherContactInfo`	Model	Optional	Expand Create a vendor — request body — body Other Contact Info List of ContactInfo entities of any contact info type.
`$ (anyOf 97).Vendor.PrimaryEmailAddr`	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
`$ (anyOf 97).Vendor.PrimaryPhone`	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
`$ (anyOf 97).Vendor.PrintOnCheckName`	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName . Cannot be removed with sparse update.
`$ (anyOf 97).Vendor.Source`	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
`$ (anyOf 97).Vendor.Suffix`	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
`$ (anyOf 97).Vendor.SyncToken`	string	Required within parent
`$ (anyOf 97).Vendor.T4AEligible`	JSON	Optional	True if vendor is T4A eligible. Valid for CA locale
`$ (anyOf 97).Vendor.T4AEligible (anyOf 1)`	boolean	Alternative
`$ (anyOf 97).Vendor.T4AEligible (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 97).Vendor.T5018Eligible`	JSON	Optional	True if vendor is T5018 eligible. Valid for CA locale
`$ (anyOf 97).Vendor.T5018Eligible (anyOf 1)`	boolean	Alternative
`$ (anyOf 97).Vendor.T5018Eligible (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 97).Vendor.TaxIdentifier`	string	Optional	The tax ID of the Person or Organization. The value is masked in responses, exposing only last four characters. For example, the ID of 123-45-6789 is returned as XXXXXXX6789 .
`$ (anyOf 97).Vendor.TermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a default Term associated with this Vendor object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for TermRef.value and TermRef.name , respectively.
`$ (anyOf 97).Vendor.Title`	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes are required during create. Conditionally required
`$ (anyOf 97).Vendor.Vendor1099`	JSON	Optional	This vendor is an independent contractor; someone who is given a 1099-MISC form at the end of the year. A 1099 vendor is paid with regular checks, and taxes are not withheld on their behalf.
`$ (anyOf 97).Vendor.Vendor1099 (anyOf 1)`	boolean	Alternative
`$ (anyOf 97).Vendor.Vendor1099 (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 97).Vendor.VendorPaymentBankDetail`	Model	Optional	Expand Create a vendor — request body — body Vendor Payment Bank Detail Vendor Payment Bank Detail.
`$ (anyOf 97).Vendor.WebAddr`	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
`$ (anyOf 97).Vendor.domain`	string	Optional
`$ (anyOf 97).Vendor.sparse`	boolean	Optional
`$ (anyOf 98)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 98).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 98).operation`	JSON	Required within parent	Must equal: create
`$ (anyOf 98).VendorCredit`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 98).VendorCredit.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 98).VendorCredit.Balance`	JSON	Optional	The current amount of the vendor credit reflecting any adjustments to the original credit amount. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 98).VendorCredit.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 98).VendorCredit.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 98).VendorCredit.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 98).VendorCredit.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 98).VendorCredit.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 98).VendorCredit.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 98).VendorCredit.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 98).VendorCredit.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 98).VendorCredit.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 98).VendorCredit.Id`	string	Optional	Unique identifier for this object. Read only: true
`$ (anyOf 98).VendorCredit.IncludeInAnnualTPAR`	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 98).VendorCredit.IncludeInAnnualTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 98).VendorCredit.IncludeInAnnualTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 98).VendorCredit.Line`	array	Required within parent	Individual line items of a transaction. Valid Line types include: ItemBasedExpenseLine and AccountBasedExpenseLine
`$ (anyOf 98).VendorCredit.Line[]`	JSON	Each item
`$ (anyOf 98).VendorCredit.Line[] (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Line item
`$ (anyOf 98).VendorCredit.Line[] (anyOf 2)`	Model	Alternative	Expand Create a bill — request body — body Line item
`$ (anyOf 98).VendorCredit.LinkedTxn`	array	Optional	Zero or more transactions linked to this object. The LinkedTxn.TxnType can be set to ReimburseCharge . The LinkedTxn.TxnId can be set as the ID of the transaction.
`$ (anyOf 98).VendorCredit.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 98).VendorCredit.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 98).VendorCredit.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the transaction to the vendor. This field maps to the Memo field on the transaction form.
`$ (anyOf 98).VendorCredit.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the VendorCredit was created from. Read only: true
`$ (anyOf 98).VendorCredit.SyncToken`	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
`$ (anyOf 98).VendorCredit.TotalAmt`	JSON	Optional	Indicates the total credit amount, determined by taking the total of all all lines of the transaction. This includes all charges, allowances, discounts, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 98).VendorCredit.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 98).VendorCredit.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 98).VendorCredit.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 98).VendorCredit.VendorRef`	Model	Required within parent	Expand Create a purchase order — request body — body Ship To The vendor reference for this transaction.
`$ (anyOf 98).VendorCredit.domain`	string	Optional
`$ (anyOf 98).VendorCredit.sparse`	boolean	Optional
`$ (anyOf 99)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 99).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 99).operation`	JSON	Required within parent	Must equal: delete
`$ (anyOf 99).VendorCredit`	Model	Required within parent	Expand Delete a vendorcredit — request body — body
`$ (anyOf 100)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 100).bId`	string	Required within parent	Minimum length: 1
`$ (anyOf 100).operation`	JSON	Required within parent	Must equal: update
`$ (anyOf 100).VendorCredit`	object	Required within parent	Additional keys: not allowed
`$ (anyOf 100).VendorCredit.APAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
`$ (anyOf 100).VendorCredit.Balance`	JSON	Optional	The current amount of the vendor credit reflecting any adjustments to the original credit amount. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 100).VendorCredit.Balance (anyOf 1)`	number	Alternative
`$ (anyOf 100).VendorCredit.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 100).VendorCredit.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
`$ (anyOf 100).VendorCredit.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`$ (anyOf 100).VendorCredit.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
`$ (anyOf 100).VendorCredit.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`$ (anyOf 100).VendorCredit.ExchangeRate (anyOf 1)`	number	Alternative
`$ (anyOf 100).VendorCredit.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 100).VendorCredit.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`$ (anyOf 100).VendorCredit.Id`	string	Required within parent
`$ (anyOf 100).VendorCredit.IncludeInAnnualTPAR`	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
`$ (anyOf 100).VendorCredit.IncludeInAnnualTPAR (anyOf 1)`	boolean	Alternative
`$ (anyOf 100).VendorCredit.IncludeInAnnualTPAR (anyOf 2)`	string	Alternative	One of: true, false
`$ (anyOf 100).VendorCredit.Line`	array	Optional	Individual line items of a transaction. Valid Line types include: ItemBasedExpenseLine and AccountBasedExpenseLine
`$ (anyOf 100).VendorCredit.Line[]`	JSON	Each item
`$ (anyOf 100).VendorCredit.Line[] (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Line item
`$ (anyOf 100).VendorCredit.Line[] (anyOf 2)`	Model	Alternative	Expand Create a bill — request body — body Line item
`$ (anyOf 100).VendorCredit.LinkedTxn`	array	Optional	Zero or more transactions linked to this object. The LinkedTxn.TxnType can be set to ReimburseCharge . The LinkedTxn.TxnId can be set as the ID of the transaction.
`$ (anyOf 100).VendorCredit.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`$ (anyOf 100).VendorCredit.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`$ (anyOf 100).VendorCredit.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the transaction to the vendor. This field maps to the Memo field on the transaction form.
`$ (anyOf 100).VendorCredit.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the VendorCredit was created from. Read only: true
`$ (anyOf 100).VendorCredit.SyncToken`	string	Required within parent
`$ (anyOf 100).VendorCredit.TotalAmt`	JSON	Optional	Indicates the total credit amount, determined by taking the total of all all lines of the transaction. This includes all charges, allowances, discounts, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`$ (anyOf 100).VendorCredit.TotalAmt (anyOf 1)`	number	Alternative
`$ (anyOf 100).VendorCredit.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`$ (anyOf 100).VendorCredit.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`$ (anyOf 100).VendorCredit.VendorRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To The vendor reference for this transaction.
`$ (anyOf 100).VendorCredit.domain`	string	Optional
`$ (anyOf 100).VendorCredit.sparse`	boolean	Optional

Report an issue with this page