QuickBooksAccounting
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Creates new bill
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billLines | List | Individual line items of a transaction. |
vendorRefType | Select | Value of vendor type: name or value |
vendorRefValue | String | Value of vendor ref |
Retrieves the details of a bill that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billId | Number | Id of your bill |
Updates a bill that has been previously created. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billId | Number | Id of your bill |
syncToken | Number | Version number of the object. |
billLines | List | Individual line items of a transaction. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
apAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
apAccountRefName | String | An identifying name for the object being referenced by apAccountRefId |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
salesTermRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTermRefName | String | An identifying name for the object being referenced by salesTermRefId |
dueDate | DatePicker | Date when the payment of the transaction is due. |
balance | String | The balance reflecting any payments made against the transaction. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing bill. You must unlink any linked transactions associated with the bill object before deleting it.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billId | String | Id of the bill |
syncToken | String | Version number of the object. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Creates new bill payment by check
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billpaymentLines | List | Individual line items of a transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
bankAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
bankAccountRefName | String | An identifying name for the object being referenced by bankAccountRefId |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete. |
Creates new bill payment by credit card
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billpaymentLines | List | Individual line items of a transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
ccAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
ccAccountRefName | String | An identifying name for the object being referenced by ccAccountRefId |
Retrieves the details of a billpayment that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billpaymentId | Number | Id of your billpayment |
Updates existing bill payment by check. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billpaymentId | Number | Id of the billpayment |
billpaymentLines | List | Individual line items of a transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
syncToken | Number | Version number of the object. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
bankAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
bankAccountRefName | String | An identifying name for the object being referenced by bankAccountRefId |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
apAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
apAccountRefName | String | An identifying name for the object being referenced by apAccountRefId |
processBillPayment | Boolean | Indicates that the payment should be processed by merchant account service. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Updates existing bill payment by credit card. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
syncToken | Number | Version number of the object. |
billpaymentId | Number | Id of the billpayment |
billpaymentLines | List | Individual line items of a transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
ccAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
ccAccountRefName | String | An identifying name for the object being referenced by bankAccountRefId |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
apAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
apAccountRefName | String | An identifying name for the object being referenced by apAccountRefId |
processBillPayment | Boolean | Indicates that the payment should be processed by merchant account service. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
This operation deletes the billpayment object specified in the request body.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
billpaymentId | String | Id of the billpayment |
syncToken | String | Version number of the object. |
Create new credit memo
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
creditMemoLines | List | Individual line items of a transaction. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
Retrieves the details of a creditmemo that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
creditMemoId | Number | Id of your creditmemo |
Updates a credit memo that has been previously created. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
creditMemoId | Number | Id of your credit memo |
syncToken | Number | Version number of the object. |
creditMemoLines | List | Individual line items of a transaction. |
customField | List | Custom field or data extension. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
customerMemo | String | User-entered message to the customer; this message is visible to end user on their transactions. |
billAddr | JSON | Bill-to address of the Invoice. |
shipAddr | JSON | Identifies the address where the goods must be shipped. |
salesTermRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTermRefName | String | An identifying name for the object being referenced by salesTermRefId |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
applyTaxAfterDiscount | Boolean | 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. |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete . |
emailStatus | Select | Email status of the invoice. Valid values: NotSet, NeedToSend, EmailSent |
billEmail | String | Identifies the e-mail address where the invoice is sent. |
balance | String | The balance reflecting any payments made against the transaction. |
paymentMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
paymentMethodRefName | String | An identifying name for the object being referenced by paymentMethodRefId |
remainingCredit | String | Indicates the total credit amount still available to apply towards the payment. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Deletes existing creditmemo.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
creditMemoId | String | Id of the creditmemo |
syncToken | String | Version number of the object. |
Creates new deposit
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
depositLines | List | Individual line items of a transaction. |
depositToAccountRefId | Number | The ID for the referenced object as found in the Id field of the object payload. |
depositToAccountRefName | String | An identifying name for the object being referenced by depositToAccountRefId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a deposit that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
depositId | Number | Id of your deposit |
Updates a deposit that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
depositId | Number | Id of your deposit |
syncToken | Number | Version number of the object. |
depositLines | List | Individual line items of a transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
privateNote | String | User entered, organization-private note about the transaction. |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
txnStatus | Select | Status of the transaction. Valid values include: Draft, Overdue, Pending, Payable, Paid, Trash, and Unpaid. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
depositToAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
depositToAccountRefName | String | An identifying name for the object being referenced by vendorRefId |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
cashBack | JSON | Cash back info |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing deposit.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
depositId | String | Id of the deposit |
syncToken | String | Version number of the object. |
Create new estimate
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
estimateLines | List | Individual line items of a transaction. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a estimate that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
estimateId | Number | Id of your estimate |
Retrieves the details of a estimate that has been previously created as link to PDf file.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
estimateId | Number | Id of your estimate |
Send the specified estimate object via email.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
estimateId | Number | Id of your estimate |
String | Email address |
Updates a estimate that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
estimateId | Number | Id of your estimate |
syncToken | Number | Version number of the object. |
estimateLines | List | Individual line items of a transaction. |
customField | List | Custom field or data extension. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnStatus | Select | Status of the transaction. Valid values include: Accepted, Closed, Pending, Rejected |
linkedTxn | List | Zero or more Invoice objects related to this transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
customerMemo | String | User-entered message to the customer; this message is visible to end user on their transactions. |
billAddr | JSON | Bill-to address of the Invoice. |
shipAddr | JSON | Identifies the address where the goods must be shipped. |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
salesTermRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTermRefName | String | An identifying name for the object being referenced by salesTermRefId |
shipMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
shipMethodRefName | String | An identifying name for the object being referenced by shipMethodRefId |
dueDate | DatePicker | Date when the payment of the transaction is due. |
shipDate | DatePicker | Date for delivery of goods or services. |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
applyTaxAfterDiscount | Boolean | 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. |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete . |
emailStatus | Select | Email status of the invoice. Valid values: NotSet, NeedToSend, EmailSent |
billEmail | String | Identifies the e-mail address where the invoice is sent. |
expirationDate | DatePicker | Date by which estimate must be accepted before invalidation. |
acceptedBy | String | Name of customer who accepted the estimate. |
acceptedDate | DatePicker | Date estimate was accepted. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing estimate.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
estimateId | String | Id of the estimate |
syncToken | String | Version number of the object. |
Create new invoice
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceLines | List | Individual line items of a transaction. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
Retrieves the details of a invoice that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceId | Number | Id of your invoice |
Retrieves the details of a invoice that has been previously created as link to PDF file.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceId | Number | Id of your invoice |
Send the specified invoice object via email.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceId | Number | Id of your invoice |
String | Email address |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Use this operation to void an existing invoice object
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceId | String | Id of the invoice |
syncToken | String | Version number of the object. |
Updates an invoice that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceId | Number | Id of your estimate |
syncToken | Number | Version number of the object. |
invoiceLines | List | Individual line items of a transaction. |
customField | List | Custom field or data extension. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnStatus | Select | Status of the transaction. Valid values include: Accepted, Closed, Pending, Rejected |
linkedTxn | List | Zero or more Invoice objects related to this transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
billAddr | JSON | Bill-to address of the Invoice. |
shipAddr | JSON | Identifies the address where the goods must be shipped. |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
salesTermRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTermRefName | String | An identifying name for the object being referenced by salesTermRefId |
shipMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
shipMethodRefName | String | An identifying name for the object being referenced by shipMethodRefId |
dueDate | DatePicker | Date when the payment of the transaction is due. |
shipDate | DatePicker | Date for delivery of goods or services. |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
trackingNum | String | Shipping provider’s tracking number for the delivery of the goods associated with the transaction. |
applyTaxAfterDiscount | Boolean | 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. |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete . |
emailStatus | Select | Email status of the invoice. Valid values: NotSet, NeedToSend, EmailSent |
billEmail | String | Identifies the e-mail address where the invoice is sent. |
billEmailCc | String | Identifies the carbon copy e-mail address where the invoice is sent. |
billEmailBcc | String | Identifies the blind carbon copy e-mail address where the invoice is sent. |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
deposit | String | The deposit made towards this invoice. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
customerMemo | String | User-entered message to the customer; this message is visible to end user on their transactions. |
Deletes existing invoice
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
invoiceId | String | Id of the invoice |
syncToken | String | Version number of the object. |
Create new journal entry
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
journalentryLines | List | Individual line items of a transaction. |
journalCodeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
journalCodeRefName | String | An identifying name for the object being referenced by customerRefId |
Retrieves the details of a journal entry that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
journalentryId | Number | Id of your journal entry |
Updates an journal entry that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
journalentryId | Number | Id of your journal entry |
syncToken | Number | Version number of the object. |
journalentryLines | List | Individual line items of a transaction. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
adjustment | Boolean | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. By default, this is recalculated by the system based on sub-items total and overridden. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Deletes existing journal entry.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
journalentryId | String | Id of the journal entry |
syncToken | String | Version number of the object. |
Create new payment
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a payment that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
paymentId | Number | Id of your payment |
Updates a payment that has been previously created. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
paymentId | Number | Id of your payment |
syncToken | Number | Version number of the object. |
paymentLines | List | Individual line items of a transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
txnStatus | String | The status of the transaction. For Payment objects, this status is always set to PAID. |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
aRAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
aRAccountRefName | String | An identifying name for the object being referenced by aRAccountRefId |
depositToAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
depositToAccountRefName | String | An identifying name for the object being referenced by depositToAccountRefId |
paymentMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
paymentMethodRefName | String | An identifying name for the object being referenced by paymentMethodRefId |
paymentRefNum | String | The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation. |
creditCardPayment | JSON | Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API. |
totalAmt | String | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Use this operation to void an existing payment object
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
paymentId | String | Id of the payment |
syncToken | String | Version number of the object. |
Deletes existing payment
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
paymentId | String | Id of the payment |
syncToken | String | Version number of the object. |
Create new purchase
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseLines | List | Individual line items of a transaction. |
accountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
accountRefName | String | An identifying name for the object being referenced by customerRefId |
paymentType | Select | Payment Type can be Cash, Check, or CreditCard |
Retrieves the details of a purchase that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseId | Number | Id of your purchase |
Updates a purchase that has been previously created. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseId | Number | Id of your purchase |
syncToken | Number | Version number of the object. |
paymentType | Select | Type can be Cash, Check, or CreditCard. |
purchaseLines | List | Individual line items of a transaction. |
accountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
accountRefName | String | An identifying name for the object being referenced by accountRefId |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
paymentMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
paymentMethodRefName | String | An identifying name for the object being referenced by paymentMethodRefId |
entityRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
entityRefName | String | An identifying name for the object being referenced by entityRefId |
credit | Boolean | False—it represents a charge.True—it represents a refund. Valid only for CreditCardpayment type. |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Deletes existing purchase.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseId | String | Id of the purchase |
syncToken | String | Version number of the object. |
Create new purchase order
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseorderLines | List | Individual line items of a transaction. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
aPAccountRefID | String | The ID for the referenced object as found in the Id field of the object payload. |
aPAccountRefName | String | An identifying name for the object being referenced by aPAccountRefID |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a purchase order that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseorderId | Number | Id of your purchase |
Updates a purchase order that has been previously created. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseorderId | Number | Id of your purchase order |
syncToken | Number | Version number of the object. |
purchaseorderLines | List | Individual line items of a transaction. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
aPAccountRefID | String | The ID for the referenced object as found in the Id field of the object payload. |
aPAccountRefName | String | An identifying name for the object being referenced by aPAccountRefID |
customField | List | Custom field or data extension. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
privateNote | String | User entered, organization-private note about the transaction. |
linkedTxn | List | Zero or more Invoice objects related to this transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
memo | String | A message for the vendor. This text appears on the Purchase Order object sent to the vendor. |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
salesTermRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTermRefName | String | An identifying name for the object being referenced by salesTermRefId |
dueDate | DatePicker | Date when the payment of the transaction is due. |
vendorAddr | JSON | Address to which the payment should be sent. |
shipAddr | JSON | Address to which the vendor shipped or will ship any goods associated with the purchase. |
shipMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
shipMethodRefName | String | An identifying name for the object being referenced by shipMethodRefId |
poStatus | Select | Purchase order status. Valid values are: Open and Closed. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing purchase order.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
purchaseorderId | String | Id of the purchase order |
syncToken | String | Version number of the object. |
Create new refund receipt
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
refundLines | List | Individual line items of a transaction. |
depositToAccountId | String | The ID for the referenced object as found in the Id field of the object payload. |
depositToAccountName | String | An identifying name for the object being referenced by depositToAccountId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a refund receipt that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
refundId | Number | Id of your refund receipt |
Updates an refund receipt that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
refundId | Number | Id of your refund receipt |
syncToken | Number | Version number of the object. |
refundLines | List | Individual line items of a transaction. |
depositToAccountRefId | Number | The ID for the referenced object as found in the Id field of the object payload. |
depositToAccountRefName | String | An identifying name for the object being referenced by depositToAccountRefId |
customField | List | Custom field or data extension. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
privateNote | String | User entered, organization-private note about the transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
customerMemo | String | User-entered message to the customer; this message is visible to end user on their transactions. |
billAddr | JSON | Bill-to address of the Invoice. |
shipAddr | JSON | Identifies the address where the goods must be shipped. |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
totalAmt | String | Indicates the total amount of the associated with this payment. |
applyTaxAfterDiscount | Boolean | 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. |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete. |
billEmail | String | Identifies the e-mail address where the invoice is sent. |
balance | String | The balance reflecting any payments made against the transaction. |
paymentMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
paymentMethodRefName | String | An identifying name for the object being referenced by paymentMethodRefId |
paymentRefNum | String | The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation. |
paymentType | Select | Payment Type can be Cash, Check, or CreditCard |
checkPayment | JSON | Information about a check payment for the transaction. |
creditCardPayment | JSON | Information about a credit card for the transaction. |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing refund receipt. You must unlink any linked transactions associated with the refund receipt object before deleting it.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
refundId | String | Id of the refund receipt |
syncToken | String | Version number of the object. |
Create new sales receipt
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptLines | List | Individual line items of a transaction. |
Retrieves the details of a invoice that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptId | Number | Id of your sales receipt |
Retrieves the details of a sales receipt that has been previously created as link to PDf file.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptId | Number | Id of your sales receipt |
Send the specified sales receipt object via email.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptId | Number | Id of your sales receipt |
String | Email address |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Use this operation to void an existing sales receipt object
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptId | String | Id of the sales receipt |
syncToken | String | Version number of the object. |
Updates an sales receipt that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptId | Number | Id of your sales receipt |
syncToken | Number | Version number of the object. |
salesreceiptLines | List | Individual line items of a transaction. |
customField | List | Custom field or data extension. |
docNumber | String | Reference number for the transaction. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
privateNote | String | User entered, organization-private note about the transaction. |
txnTaxDetail | JSON | This data type provides information for taxes charged on the transaction as a whole. |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
customerMemo | String | User-entered message to the customer; this message is visible to end user on their transactions. |
billAddr | JSON | Bill-to address of the Invoice. |
shipAddr | JSON | Identifies the address where the goods must be shipped. |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
shipMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
shipMethodRefName | String | An identifying name for the object being referenced by shipMethodRefId |
shipDate | DatePicker | Date for delivery of goods or services. |
trackingNum | String | Shipping provider’s tracking number for the delivery of the goods associated with the transaction. |
totalAmt | String | Indicates the total amount of the associated with this payment. |
printStatus | Select | Printing status of the invoice. Valid values: NotSet, NeedToPrint, PrintComplete. |
emailStatus | Select | Email status of the invoice. Valid values: NotSet, NeedToSend, EmailSent |
billEmail | String | Identifies the e-mail address where the invoice is sent. |
paymentMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
paymentMethodRefName | String | An identifying name for the object being referenced by paymentMethodRefId |
paymentRefNum | String | The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation. |
creditCardPayment | JSON | Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API. |
txnSource | String | Used internally to specify originating source of a credit card transaction. |
applyTaxAfterDiscount | Boolean | 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. |
depositToAccountRefId | Number | The ID for the referenced object as found in the Id field of the object payload. |
depositToAccountRefName | String | An identifying name for the object being referenced by depositToAccountRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing sales receipt.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
salesreceiptId | String | Id of the sales receipt |
syncToken | String | Version number of the object. |
Create new transfer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
amount | String | Amount to transfer |
fromAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
fromAccountRefName | String | An identifying name for the object being referenced by fromAccountRefId |
toAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
toAccountRefName | String | An identifying name for the object being referenced by toAccountRefId |
Retrieves the details of a transfer that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
transferId | Number | Id of your transfer |
Update existing transfer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
transferId | Number | Id of the transfer |
amount | String | Amount to transfer |
fromAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
fromAccountRefName | String | An identifying name for the object being referenced by fromAccountRefId |
toAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
toAccountRefName | String | An identifying name for the object being referenced by toAccountRefId |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
privateNote | String | User entered, organization-private note about the transaction. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Deletes existing transfer.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
transferId | String | Id of the transfer |
syncToken | String | Version number of the object. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new timactivity for employee
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
startTime | DatePicker | Start of time activity |
endTime | DatePicker | End of time activity |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
employeeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
employeeRefName | String | An identifying name for the object being referenced by employeeRefId |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
hourlyRate | String | Hourly bill rate of the employee for this time activity. |
Create new timactivity for vendor
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
startTime | DatePicker | Start of time activity |
endTime | DatePicker | End of time activity |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
hourlyRate | String | Hourly bill rate of the vendor for this time activity. |
Retrieves the details of a time activity that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
timeactivityId | Number | Id of your time activity |
Update existing timactivity for employee. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
timeactivityId | String | Id of time activity |
syncToken | String | Version number of the object. |
startTime | DatePicker | Start of time activity |
endTime | DatePicker | End of time activity |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
employeeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
employeeRefName | String | An identifying name for the object being referenced by employeeRefId |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
hourlyRate | String | Hourly bill rate of the employee for this time activity. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
billableStatus | Select | Billable status of the time recorded. Valid values: Billable, NotBillable, HasBeenBilled. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
itemRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
itemRefName | String | An identifying name for the object being referenced by itemRefId |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
taxable | Boolean | True if the time recorded is both billable and taxable. |
breakHours | String | Hours of break taken between StartTime and EndTime. |
breakMinutes | String | Minutes of break taken between StartTime and EndTime. |
description | String | Description of work completed during time activity. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Update existing timeactivity for vendor. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
timeactivityId | String | Id of time activity |
syncToken | String | Version number of the object. |
startTime | DatePicker | Start of time activity |
endTime | DatePicker | End of time activity |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
customerRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
customerRefName | String | An identifying name for the object being referenced by customerRefId |
hourlyRate | String | Hourly bill rate of the employee for this time activity. |
txnDate | DatePicker | The date entered by the user when this transaction occurred. |
billableStatus | Select | Billable status of the time recorded. Valid values: Billable, NotBillable, HasBeenBilled. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
itemRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
itemRefName | String | An identifying name for the object being referenced by itemRefId |
classRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
classRefName | String | An identifying name for the object being referenced by classRefId |
taxable | Boolean | True if the time recorded is both billable and taxable. |
breakHours | String | Hours of break taken between StartTime and EndTime. |
breakMinutes | String | Minutes of break taken between StartTime and EndTime. |
description | String | Description of work completed during time activity. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
Deletes existing time activity.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
timeactivityId | String | Id of the time activity |
syncToken | String | Version number of the object. |
Creates new vendor credit
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorcreditLines | List | Individual line items of a transaction. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
Retrieves the details of a vendor credit that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorcreditId | Number | Id of your vendor credit |
Update existing vendor credit
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorcreditId | Number | Id of the vendor credit |
syncToken | Number | Version number of the object. |
vendorcreditLines | List | Individual line items of a transaction. |
vendorRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
vendorRefName | String | An identifying name for the object being referenced by vendorRefId |
docNumber | String | Reference number for the transaction. |
departmentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
departmentRefName | String | An identifying name for the object being referenced by departmentRefId |
apAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
apAccountRefName | String | An identifying name for the object being referenced by apAccountRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
exchangeRate | String | The number of home currency units it takes to equal one unit of currency specified by currencyRef |
globalTaxCalculation | Select | Method in which tax is applied. Allowed values are: TaxExcluded, TaxInclusive, and NotApplicable. |
transactionLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
privateNote | String | User entered, organization-private note about the transaction. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
This operation deletes the vendor credit object specified in the request body.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorcreditId | String | Id of the vendor credit |
syncToken | String | Version number of the object. |
Create new account
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
name | String | User recognizable name for the Account. attribute must not contain double quotes (") or colon (😃. |
accountType | Select | A detailed account classification that specifies the use of this account. The type is based on the Classification. |
accountSubType | String | The account sub-type classification and is based on the AccountType value. |
acctNum | String | 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 |
taxCodeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
taxCodeRefName | String | An identifying name for the object being referenced by taxCodeRefId |
Retrieves the details of a account that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountId | Number | Id of your account |
Update existing account. he request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountId | Number | Id of the account |
syncToken | Number | Version number of the object. |
name | String | User recognizable name for the Account. attribute must not contain double quotes (") or colon (😃. |
accountType | Select | A detailed account classification that specifies the use of this account. The type is based on the Classification. |
accountSubType | String | The account sub-type classification and is based on the AccountType value. |
accountAlias | String | A user friendly name for the account. It must be unique across all account categories. |
txnLocationType | Select | The account location. Valid values include: WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.For France locales, only. |
active | Boolean | Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to. |
classification | Select | The classification of an account. Not supported for non-posting accounts. Valid values include: Asset, Equity, Expense, Liability, Revenue |
acctNum | String | 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 |
description | String | 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. |
taxCodeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
taxCodeRefName | String | An identifying name for the object being referenced by taxCodeRefId |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new class
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
name | String | User recognizable name for the class. |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
Retrieves the details of a class that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
classId | Number | Id of your class |
Update existing class. he request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
classId | Number | Id of the class |
syncToken | Number | Version number of the object. |
name | String | User recognizable name for the class. |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
fullyQualifiedName | String | Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub class separated by colons. |
active | Boolean | If true, this entity is currently enabled for use by QuickBooks. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new company currency
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
code | String | A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR, and so on. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a company currency that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
currencyId | Number | Id of your company currency |
Update existing company currency
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
currencyId | Number | Id of the currency |
syncToken | Number | Version number of the object. |
code | String | A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR, and so on. |
active | Boolean | If true, this entity is currently enabled for use by QuickBooks. |
This operation deletes the company currency object specified in the request body.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
currencyId | String | Id of the company currency |
syncToken | String | Version number of the object. |
Create new customer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
displayName | String | 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. |
title | String | Title of the person. |
givenName | String | Given name or first name of a person. |
middleName | String | Middle name of the person. |
familyName | String | Family name or the last name of the person. |
suffix | String | Suffix of the name. For example, Jr. |
Retrieves the details of a customer that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
customerId | Number | Id of your customer |
Update existing customer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
customerId | Number | Id of the customer |
syncToken | String | Version number of the object. |
displayName | String | 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. |
title | String | Title of the person. |
givenName | String | Given name or first name of a person. |
middleName | String | Middle name of the person. |
familyName | String | Family name or the last name of the person. |
suffix | String | Suffix of the name. For example, Jr. |
companyName | String | The name of the company associated with the person or organization. |
printOnCheckName | String | Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. |
active | String | If true, this entity is currently enabled for use by QuickBooks. |
primaryPhone | String | Primary phone number. |
alternatePhone | String | Alternate phone number. |
mobile | String | Mobile phone number. |
fax | String | Fax phone number. |
primaryEmailAddr | String | Primary email address. |
webAddr | String | Website address. |
defaultTaxCodeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
defaultTaxCodeRefName | String | An identifying name for the object being referenced by defaultTaxCodeRefId |
taxable | Boolean | If true, transactions for this customer are taxable. |
billAddr | JSON | Bill-to address of the Invoice. |
shipAddr | JSON | Identifies the address where the goods must be shipped. |
notes | String | Free form text describing the Customer. |
job | Boolean | 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. |
billWithParent | Boolean | If true, this Customer object is billed with its parent. |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
level | Number | 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 |
salesTermRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTermRefName | String | An identifying name for the object being referenced by salesTermRefId |
paymentMethodRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
paymentMethodRefName | String | An identifying name for the object being referenced by paymentMethodRefId |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
preferredDeliveryMethod | String | Preferred delivery method. Values are Print, Email, or None. |
resaleNum | String | Resale number or some additional info about the customer. |
aRAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
aRAccountRefName | String | An identifying name for the object being referenced by aRAccountRefId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new department
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
name | String | User recognizable name for the department. |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
Retrieves the details of a department that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
departmentId | Number | Id of your department |
Update existing department. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
departmentId | Number | Id of the department |
syncToken | Number | Version number of the object. |
name | String | User recognizable name for the class. |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
fullyQualifiedName | String | Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub class separated by colons. |
active | Boolean | If true, this entity is currently enabled for use by QuickBooks. |
subDepartment | Boolean | Specifies whether this Department object is a SubDepartment. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new employee
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
givenName | String | Given name or first name of a person. |
familyName | String | Family name or the last name of the person. |
primaryAddr | JSON | Represents the physical street address for this employee. |
Retrieves the details of a employee that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
employeeId | Number | Id of your employee |
Update existing employee
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
employeeId | Number | Id of the employee |
givenName | String | Given name or first name of a person. |
familyName | String | Family name or the last name of the person. |
primaryAddr | JSON | Represents the physical street address for this employee. |
title | String | Title of the person. |
middleName | String | Middle name of the person. |
suffix | String | Suffix of the name. For example, Jr. |
organization | Boolean | true–the object represents an organization. false–the object represents a person. |
displayName | String | 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. |
printOnCheckName | String | Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. |
active | Boolean | If true, this entity is currently enabled for use by QuickBooks. |
primaryPhone | String | Primary phone number. |
mobile | String | Mobile phone number. |
primaryEmailAddr | String | Primary email address. |
employeeNumber | String | Specifies the ID number of the employee in the employer’s directory. |
ssn | String | Social security number (SSN) of the employee. |
primaryAddr | String | Represents the physical street address for this employee. |
billableTime | Boolean | If true, this entity is currently enabled for use by QuickBooks. |
billRate | String | This attribute can only be set if BillableTime is true. Not supported when QuickBooks Payroll is enabled. |
birthDate | DatePicker | Birth date of the employee. |
gender | Select | Gender of the employee. To clear the gender value, set to Null in a full update request. Supported values include: Male or Female. |
hiredDate | DatePicker | Hire date of the employee. |
releasedDate | DatePicker | Release date of the employee. |
syncToken | Number | Version number of the object. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new item
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
name | String | User recognizable name for the item. |
incomeAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
incomeAccountRefName | String | An identifying name for the object being referenced by incomeAccountRefId |
expenseAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
expenseAccountRefName | String | An identifying name for the object being referenced by expenseAccountRefId |
assetAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
assetAccountRefName | String | An identifying name for the object being referenced by assetAccountRefId |
invStartDate | DatePicker | Date of opening balance for the inventory transaction. |
Retrieves the details of a item that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
itemId | Number | Id of your item |
Update existing item
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
itemId | Number | Id of the item |
syncToken | String | Version number of the object. |
name | String | User recognizable name for the item. |
incomeAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
incomeAccountRefId | String | An identifying name for the object being referenced by incomeAccountRefId |
expenseAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
expenseAccountRefName | String | An identifying name for the object being referenced by expenseAccountRefId |
assetAccountRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
assetAccountRefName | String | An identifying name for the object being referenced by assetAccountRefId |
invStartDate | DatePicker | Date of opening balance for the inventory transaction. |
sku | String | The stock keeping unit (SKU) for this Item. |
description | String | Description of the item. |
active | Boolean | If true, the object is currently enabled for use by QuickBooks. |
subItem | Boolean | If true, this is a sub item. If false or null, this is a top-level item. |
parentRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
parentRefName | String | An identifying name for the object being referenced by parentRefId |
taxable | Boolean | If true, transactions for this item are taxable. Applicable to US companies, only. |
salesTaxIncluded | Boolean | True if the sales tax is included in the item amount, and therefore is not calculated for the transaction. |
unitPrice | String | Price of the unit |
purchaseDesc | String | Purchase description for the item. |
purchaseTaxIncluded | Boolean | True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction. |
purchaseCost | String | Amount paid when buying or ordering the item, as expressed in the home currency. |
trackQtyOnHand | Boolean | True if there is quantity on hand to be tracked. |
qtyOnHand | String | Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items. |
salesTaxCodeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
salesTaxCodeRefName | String | An identifying name for the object being referenced by salesTaxCodeRefId |
purchaseTaxCodeRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
purchaseTaxCodeRefName | String | An identifying name for the object being referenced by purchaseTaxCodeRefId |
Create new payment method
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
name | String | User recognizable name for the payment method. |
Retrieves the details of a payment method that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
paymentmethodId | Number | Id of your payment method |
Update existing payment method. Writable fields omitted from the request body are set to NULL.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
paymentmethodId | Number | Id of the payment method |
syncToken | Number | Version number of the object. |
name | String | User recognizable name for the payment method. |
type | Select | Defines the type of payment. Valid values include CREDIT_CARD or NON_CREDIT_CARD. |
active | Boolean | If true, this entity is currently enabled for use by QuickBooks. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new tax agency
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
displayName | String | User recognizable name for the tax agency. |
Retrieves the details of a tax agency that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
taxAgencyId | Number | Id of your tax agency |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the details of a tax code that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
taxCodeId | Number | Id of your tax code |
Retrieves the details of a tax rate that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
taxRateId | Number | Id of your tax rate |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new tax service
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
taxCode | String | Name of new tax code. |
taxRateDetails | List | One or more tax rate specifications. |
Create new term
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
name | String | User recognizable name for the term. |
dueDays | Number | Number of days from delivery of goods or services until the payment is due. 0 - 999 |
Retrieves the details of a term that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
termId | Number | Id of your term |
Update a term that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
termId | Number | Id of your term |
syncToken | Number | Version number of the object. |
name | String | User recognizable name for the term. |
dueDays | Number | Number of days from delivery of goods or services until the payment is due. 0 - 999 |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Create new vendor
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
displayName | String | The name of the organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. |
title | String | Title of the person. |
givenName | String | Given name or first name of a person. |
middleName | String | Middle name of the person. |
familyName | String | Family name or the last name of the person. |
suffix | String | Suffix of the name. For example, Jr. |
Retrieves the details of a vendor that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorId | Number | Id of your vendor |
Update existing vendor
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
vendorId | Number | Id of the vendor |
syncToken | String | Version number of the object. |
displayName | String | 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. |
title | String | Title of the person. |
givenName | String | Given name or first name of a person. |
middleName | String | Middle name of the person. |
familyName | String | Family name or the last name of the person. |
suffix | String | Suffix of the name. For example, Jr. |
companyName | String | The name of the company associated with the person or organization. |
printOnCheckName | String | Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. |
active | String | If true, this entity is currently enabled for use by QuickBooks. |
primaryPhone | String | Primary phone number. |
alternatePhone | String | Alternate phone number. |
mobile | String | Mobile phone number. |
fax | String | Fax phone number. |
primaryEmailAddr | String | Primary email address. |
webAddr | String | Website address. |
termRefId | String | The ID for the referenced object as found in the Id field of the object payload. |
termRefName | String | An identifying name for the object being referenced by termRefId |
taxable | Boolean | If true, transactions for this customer are taxable. |
billAddr | JSON | Bill-to address of the Invoice. |
otherContactInfo | JSON | List of ContactInfo entities of any contact info type. |
acctNum | String | Name or number of the account associated with this vendor. |
vendor1099 | Boolean | 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. |
currencyRefId | String | A three letter string representing the ISO 4217 code for the currency. |
currencyRefName | String | An identifying name for the currency being referenced by currencyRefId |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountStatus | Select | The account status. Supported values include: Deleted, Not_Deleted |
accountType | Select | Account type from which transactions are included in the report. |
columns | Select | Column types to be shown in the report. Supported Values: account_name*, account_type*, detail_acc_type, create_date, create_by, detail_acc_type*, last_mod_date, last_mod_by, account_desc*, account_bal* |
createdateMacro | String | Predefined report account create date range. |
moddateMacro | String | Predefined report account modification date range. |
sortBy | String | The column type used in sorting report rows. Specify a column type as defined with the columns query parameter, above. |
sortOrder | Select | The sort order. Supported Values: ascend, descend |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
startModdate | DatePicker | Specify an explicit account modification report date range, in the format YYYY-MM-DD. |
endModdate | DatePicker | Specify an explicit account modification report date range, in the format YYYY-MM-DD. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
agingPeriod | Number | The number of days in the aging period. |
columns | Select | Column types to be shown in the report. Supported Values: create_by create_date doc_num* due_date* last_mod_by last_mod_date memo* past_due* term_name tx_date* txn_type* vend_bill_addr vend_comp_name vend_name* vend_pri_cont vend_pri_email vend_pri_tel Additional columns with location tracking enabled: dept_name* |
custom1 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
custom2 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
custom3 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
numPeriods | Number | The number of periods to be shown in the report. |
pastDue | Number | Filters report contents based on minimum days past due. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
shipvia | String | Filter by the shipping method |
startDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
endDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
term | String | Filters report contents based on term or terms supplied. |
vendor | String | Filters report contents to include information for specified vendors. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
agingMethod | Select | The date upon which aging is determined. Supported Values:Report_Date, Current |
customer | String | Filters report contents to include information for specified customers. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
vendor | List | Filters report contents to include information for specified vendors. Supported Values: One or more comma separated vendor IDs as returned in the attribute, Vendor.Id, of the Vendor object response code. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
agingMethod | Select | The date upon which aging is determined. Supported Values:Report_Date, Current |
agingPeriod | Number | The number of days in the aging period. |
columns | Select | Column types to be shown in the report. Supported Values: bill_addr create_by create_date cust_bill_email cust_comp_name cust_msg cust_phone_other cust_tel cust_name deliv_addr doc_num* due_date* last_mod_by last_mod_date memo* past_due sale_sent_state ship_addr term_name tx_date* txn_type* Additional columns with custom fields enabled: sales_cust1 sales_cust2 sales_cust3 Additional columns with location tracking enabled: dept_name* |
custom1 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
custom2 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
custom3 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
numPeriods | Number | The number of periods to be shown in the report. |
pastDue | Number | Filters report contents based on minimum days past due. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
shipvia | String | Filter by the shipping method |
startDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
endDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
term | String | Filters report contents based on term or terms supplied. |
customer | String | Filters report contents to include information for specified customers. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
agingMethod | Select | The date upon which aging is determined. Supported Values:Report_Date, Current |
customer | String | Filters report contents to include information for specified customers. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item< | String | Filters report contents to include information for specified items. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
vendor | String | Filters report contents to include information for specified vendors. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item< | String | Filters report contents to include information for specified items. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
vendor | String | Filters report contents to include information for specified vendors. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
arpaid | Select | Supported Values:All, Paid, Unpaid |
customer | String | Filters report contents to include information for specified customers. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
agingMethod | String | The date upon which aging is determined. Supported Values:Report_Date, Current |
arpaid | Select | Supported Values:All, Paid, Unpaid |
columns | String | Column types to be shown in the report. Supported Values: bill_addr create_by create_date cust_bill_email cust_comp_name cust_msg cust_phone_other cust_tel cust_name deliv_addr doc_num* due_date* last_mod_by last_mod_date memo* past_due sale_sent_state ship_addr term_name tx_date* txn_type* Additional columns with custom fields enabled: sales_cust1 sales_cust2 sales_cust3 Additional columns with location tracking enabled: dept_name* |
custom1 | String | Filter by the specified custom field as defined by the CustomField attribute in transaction entities where supported. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
sortBy | String | The column type used in sorting report rows. Specify a column type as defined with the columns query parameter, above. |
sortOrder | Select | The sort order. Supported Values: ascend, descend |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
shipvia | String | Filter by the shipping method |
startDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
endDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
term | String | Filters report contents based on term or terms supplied. |
customer | String | Filters report contents to include information for specified customers. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
term | String | Filters report contents based on term or terms supplied. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
vendor | String | Filters report contents to include information for specified vendors. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
vendor | String | Filters report contents to include information for specified vendors. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
account | String | Filters report contents to include information for specified accounts. |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
accountType | Select | Supported Values: AccountsPayable AccountsReceivable Bank CostOfGoodsSold CreditCard Equity Expense FixedAsset Income LongTermLiability NonPosting OtherAsset OtherCurrentAsset OtherCurrentLiability OtherExpense OtherIncome |
sourceAccountType | Select | Supported Values: AccountsPayable AccountsReceivable Bank CostOfGoodsSold CreditCard Equity Expense FixedAsset Income LongTermLiability NonPosting OtherAsset OtherCurrentAsset OtherCurrentLiability OtherExpense OtherIncome |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
columns | Select | Supported values: account_name chk_print_state create_by create_date cust_name doc_num* emp_name inv_date is_adj* is_ap_paid is_ar_paid is_cleared item_name last_mod_by last_mod_date memo* name* quantity rate split_acc* tx_date* txn_type* vend_name Additional columns when sales tax enabled: net_amount tax_amount tax_code Additional columns when account numbering enabled: account_num Additional columns when class tracking enabled: klass_name* Additional columns when location tracking enabled: dept_name* |
customer | String | Filters report contents to include information for specified customers. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
sortBy | String | The column type used in sorting report rows. Specify a column type as defined with the columns query parameter, above. |
sortOrder | Select | The sort order. Supported Values: ascend, descend |
vendor | String | Filters report contents to include information for specified vendors. |
sourceAccount | String | Filters report contents to include information for specified source accounts. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
item | String | Filters report contents to include information for specified items. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item | String | Filters report contents to include information for specified items. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
vendor | String | Filters report contents to include information for specified vendors. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
account | String | Filters report contents to include information for specified accounts. |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
accountType | Select | Supported Values: AccountsPayable AccountsReceivable Bank CostOfGoodsSold CreditCard Equity Expense FixedAsset Income LongTermLiability NonPosting OtherAsset OtherCurrentAsset OtherCurrentLiability OtherExpense OtherIncome |
sourceAccountType | Select | Supported Values: AccountsPayable AccountsReceivable Bank CostOfGoodsSold CreditCard Equity Expense FixedAsset Income LongTermLiability NonPosting OtherAsset OtherCurrentAsset OtherCurrentLiability OtherExpense OtherIncome |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
columns | String | Supported values: create_by create_date doc_num* last_mod_by last_mod_date memo* name* pmt_mthd split_acc* tx_date* txn_type* Additional columns with tax enabled: tax_code Additional columns with account numbering enabled: account_num Additional columns with class tracking enabled: klass_name* Additional columns with location tracking enabled: dept_name* |
customer | String | Filters report contents to include information for specified customers. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
employee | String | Filters report contents to include information for specified employees. |
paymentMethod | String | Filters report contents based on payment method. Supported Values: Cash, Check, Dinners Club, American Express, Discover, MasterCard, Visa |
sortBy | String | The column type used in sorting report rows. Specify a column type as defined with the columns query parameter, above. |
sortOrder | Select | The sort order. Supported Values: ascend, descend |
vendor | String | Filters report contents to include information for specified vendors. |
sourceAccount | String | Filters report contents to include information for specified source accounts. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item< | String | Filters report contents to include information for specified items. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item< | String | Filters report contents to include information for specified items. |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item< | String | Filters report contents to include information for specified items. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
customer | String | Filters report contents to include information for specified customers. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
item< | String | Filters report contents to include information for specified items. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
arpaid | Select | Supported Values:All, Paid, Unpaid |
bothamount | String | Filters report contents to include information for specified transaction amount. |
class | String | Filters report contents to include information for specified classes if so configured in the company file. |
cleared | Select | Filters report contents to include information for specified check status. Supported Values: Cleared, Uncleared, Reconciled, Deposited |
columns | Select | Supported Values: account_name* create_by create_date cust_msg due_date doc_num* inv_date is_ap_paid is_cleared is_no_post* last_mod_by memo* name* other_account* pmt_mthd printed sales_cust1 sales_cust2 sales_cust3 term_name tracking_num tx_date* txn_type* term_name Additional columns when account numbering enabled: account_num Additional columns when location tracking enabled: dept_name* |
createdateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
customer | String | Filters report contents to include information for specified customers. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
docnum | String | Filters report contents to include information for specified transaction number, as found in the docnum parameter of the transaction object. |
duedateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
groupBy | Select | The field in the transaction by which to group results. Supported Values: Name, Account, Transaction Type, Customer, Vendor, Employee, Location, Payment Method, Day, Week, Month, Quarter, Year, None |
item | String | Filters report contents to include information for specified items. |
memo | List | Filters report contents to include information for specified memo. Supported Values: One or more comma separated memo IDs. |
moddateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
name | String | Filters report contents based on the specified comma separated list of ids for the name list customer, vendor, or employee objects. |
paymentMethod | Select | Filters report contents based on payment method. Supported Values: Cash, Check, Dinners Club, American Express, Discover, MasterCard, Visa |
printed | Select | Filters report contents based on whether checks are printed or not. Supported Values: Printed, To_be_printed |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
sortBy | String | The column type used in sorting report rows. Specify a column type as defined with the columns query parameter, above. |
sortOrder | Select | The sort order. Supported Values: ascend, descend |
sourceAccountType | Select | Supported Values: AccountsPayable AccountsReceivable Bank CostOfGoodsSold CreditCard Equity Expense FixedAsset Income LongTermLiability NonPosting OtherAsset OtherCurrentAsset OtherCurrentLiability OtherExpense OtherIncome |
startCreatedate | DatePicker | Specify an explicit account create report date range, in the format YYYY-MM-DD |
subtendCreatedate | DatePicker | Specify an explicit account create report date range, in the format YYYY-MM-DD |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
startDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
subtendDuedate | String | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
startModdate | DatePicker | Specify an explicit account modification report date range, in the format YYYY-MM-DD. |
endModdate | DatePicker | Specify an explicit account modification report date range, in the format YYYY-MM-DD. |
term | String | Filters report contents based on term or terms supplied. |
transactionType | Select | Filters report contents based transaction type. Supported values include: CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation |
vendor | String | Filters report contents to include information for specified vendors. |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
startDate | DatePicker | The start date date of the report, in the format YYYY-MM-DD. |
endDate | DatePicker | The end date date of the report, in the format YYYY-MM-DD. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
appaid | Select | Status of the balance. Supported Values: Paid, Unpaid, All |
qzurl | String | Specifies whether Quick Zoom URL information should be generated for rows in the report. |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
vendor | String | Filters report contents to include information for specified vendors. |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
summarizeColumnBy | Select | The criteria by which to group the report results. Supported Values: Total Month Week Days Quarter Year Customers Vendors Classes Departments Employees ProductsAndServices |
Returns the results of the report request.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
accountingMethod | Select | The accounting method used in the report. Supported Values:Cash, Accrual |
appaid | Select | Status of the balance. Supported Values: Paid, Unpaid, All |
columns | Select | Column types to be shown in the report. Supported Values:create_by create_date doc_num* due_date* last_mod_by last_mod_date memo* term_name tx_date* txn_type* vend_bill_addr vend_comp_name vend_name* vend_pri_cont vend_pri_email vend_pri_tel Additional columns with location tracking enabled: dept_name* |
dateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
department | String | Filters report contents to include information for specified departments if so configured in the company file. |
duedateMacro | Select | Supported Values: Today Yesterday This Week Last Week This Week-to-date Last Week-to-date Next Week Next 4 Weeks This Month Last Month This Month-to-date Last Month-to-date Next Month This Fiscal Quarter Last Fiscal Quarter This Fiscal Quarter-to-date Last Fiscal Quarter-to-date Next Fiscal Quarter This Fiscal Year Last Fiscal Year This Fiscal Year-to-date Last Fiscal Year-to-date Next Fiscal Year |
reportDate | DatePicker | Start date to use for the report, in the format YYYY-MM-DD. |
sortBy | String | The column type used in sorting report rows. Specify a column type as defined with the columns query parameter, above. |
sortOrder | Select | The sort order. Supported Values: ascend, descend |
startDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
endDuedate | DatePicker | The range of dates over which receivables are due, in the format YYYY-MM-DD. |
term | String | Filters report contents based on term or terms supplied. |
vendor | String | Filters report contents to include information for specified vendors. |
Use this endpoint to attach a note to the an object.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
attachableRef | List | Specifies the transaction object to which this attachable file is to be linked. |
note | String | Max 2000 chars, filterable, sortable |
Retrieves the details of a attachable that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
attachableId | Number | Id of your attachable |
Updates attachable that has been previously created.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
attachableId | Number | Id of your attachable |
note | String | Text of the attachable |
syncToken | Number | Version number of the object. |
Deletes existing attachable
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
attachableId | String | Id of the attachable |
syncToken | String | Version number of the object. |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
The change data capture (cdc) operation returns a list of objects that have changed since a specified time.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
entityList | List | List of entities coma separated except JournalCode, TimeActivity, TaxAgency, TaxCode, and TaxRate. |
changedSince | DatePicker | Date of change |
Retrieves the details of the CompanyInfo object.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |
Retrieves the Preferences details for the specified company.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
se this operation to update any of the writable preference fields. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL or reverted to a default value.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
preferenceId | Number | Id of your attachable |
accountingInfoPrefs | JSON | The following settings are available for QuickBooks Online Plus editions, only. |
productAndServicesPrefs | JSON | Product and services preferences |
salesFormsPrefs | JSON | Sales forms preferences |
emailMessagesPrefs | JSON | Email messages preferences |
vendorAndPurchasesPrefs | JSON | Vendor and purchase preferences |
timeTrackingPrefs | JSON | Time tracking preferences |
taxPrefs | JSON | Tax preferences |
currencyPrefs | JSON | Currency preferences |
reportPrefs | JSON | Report preferences |
otherPrefs | JSON | Other preferences |
Returns the results of the query.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from Intuit |
apiSecret | credentials | Api secret obtained from Intuit |
accessToken | String | Access token provided by user |
tokenSecret | String | Token secret provided by user |
companyId | Number | Id of the company |
sandbox | String | Whether to run in sandbox mode |
query | String | Your query to process |