Overview
Configuration is provided for establishing connections with the QuickBooks Online service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to QuickBooks Online REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select QuickBooks Online. Then click New in the Token File parameter to create a new token file.
Step 3. Specify token scope. If your QuickBooks Online instance doesn't include the Payment feature, remove com.intuit.quickbooks.payment from scope. Press Next.
Step 4: Provide Email and Password. Then press 'Sign In' button.
Step 5: Save generated access token to file. Specify token protection password. Click OK.
Step 6. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your QuickBooks Online instance.
In this guide, we will show how to read data from the QuickBooks Online service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select QuickBooks Online connection from the combo. Select from available QuickBooks Online resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select QuickBooks Online resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from QuickBooks Online service.
In this guide, we will show how to write data to the QuickBooks Online service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select QuickBooks Online connection from the combo. Also, select action and resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the QuickBooks Online resource.
Configuration
Base URL address: https://quickbooks.api.intuit.com/v3/company.
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
- Environment:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
bearer {{=token.Access}}
Documentation: https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account#query-an-account.
- [Create] action
-
Endpoint URL address:
/account.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account#create-an-account.
- [Update] action
-
Endpoint URL address:
/account.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account#full-update-an-account.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- AcctNum
Template: ShortText.
- CurrencyRef
Template: Ref.
- ParentRef
Template: Ref.
- Description
Template: LongText.
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
- SubAccount
Data type: DT_BOOL
- Classification
Template: ShortText.
- FullyQualifiedName
Template: ShortText.
- AccountType
Template: ShortText.
- CurrentBalanceWithSubAccounts
Data type: DT_R8
- AccountSubType
Template: ShortText.
- CurrentBalance
Data type: DT_R8
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- TxnLocationType
Template: ShortText.
- AccountAlias
Template: ShortText.
- TaxCodeRef
Template: Ref.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/attachable#query-an-attachable.
- [Create] action
-
Endpoint URL address:
/attachable.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/attachable#create-a-note-attachment.
- [Update] action
-
Endpoint URL address:
/attachable.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/attachable#full-update-an-attachable.
- [Delete] action
-
Endpoint URL address:
/attachable.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/attachable#delete-an-attachable.
- Id
A key field. Template: ShortText.
- SyncToken
Template: ShortText.
- FileName
Template: ShortText.
- Note
Template: LongText.
- Category
Template: ShortText.
- ContentType
Template: ShortText.
- PlaceName
Template: ShortText.
- AttachableRef
Field components:
- An array.
- Contains the following components: IncludeOnSend, LineInfo, NoRefOnly, Inactive, EntityRef.
- Long
Data type: DT_R8
- Tag
Template: ShortText.
- Lat
Data type: DT_R8
- MetaData
Template: MetaData.
- FileAccessUri
Template: ShortText.
- Size
Data type: DT_I4
- ThumbnailFileAccessUri
Template: ShortText.
- TempDownloadUri
Template: ShortText.
- ThumbnailTempDownloadUri
Template: ShortText.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- content
Data type: DT_IMAGE The value is gathered from
{{=connection.execute({ url: '/' + connection.token.realmId + '/download/' + item.Id })}}address. The value is sent to/uploadaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/bill#query-a-bill.
- [Create] action
-
Endpoint URL address:
/bill.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/bill#create-a-bill.
- [Update] action
-
Endpoint URL address:
/bill.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/bill#full-update-a-bill.
- [Delete] action
-
Endpoint URL address:
/bill.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/bill#delete-a-bill.
The resource includes the fields from the BillT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment#query-a-billpayment.
- [Create] action
-
Endpoint URL address:
/billpayment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment#create-a-billpayment.
- [Update] action
-
Endpoint URL address:
/billpayment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment#full-update-a-billpayment.
- [Delete] action
-
Endpoint URL address:
/billpayment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment#delete-a-billpayment.
- Id
A key field. Template: ShortText.
- VendorRef
Template: Ref.
- Line
Field components:
- An array.
- Contains the following components: Amount, LinkedTxn.
- TotalAmt
Data type: DT_R8
- PayType
Template: ShortText.
- SyncToken
Template: ShortText.
- CurrencyRef
Template: Ref.
- DocNumber
Template: ShortText.
- PrivateNote
Template: LongText.
- TxnDate
Template: DateTime.
- ExchangeRate
Data type: DT_R8
- APAccountRef
Template: Ref.
- DepartmentRef
Template: Ref.
- ProcessBillPayment
Data type: DT_BOOL
- MetaData
Template: MetaData.
- CheckPayment
Field components:
-
Uses template:
Ref. - Contains the following components: BankAccountRef, PrintStatus.
-
Uses template:
- CreditCardPayment
Field components:
-
Uses template:
Ref. - Contains the following components: CCAccountRef.
-
Uses template:
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- TransactionLocationType
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/budget#query-the-budget.
- Id
A key field. Template: ShortText.
- EndDate
Template: DateTime.
- StartDate
Template: DateTime.
- SyncToken
Template: ShortText.
- BudgetEntryType
Template: ShortText.
- Name
Template: ShortText.
- BudgetDetail
Field components:
- An array.
- Contains the following components: ClassRef, DepartmentRef, Amount, BudgetDate, AccountRef, CustomerRef.
- BudgetType
Template: ShortText.
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- [Read] action
-
Endpoint URL address:
/cdc.
The result is extracted from:{{=response.CDCResponse[0].QueryResponse[0][parameters.object]}}.The action has the following user-defined parameters:
- object: Required. Specify object to get modified records.
- since: Required. Specify date and time since when you want to get the modified records.
The following request parameters will be automatically processed:
-
entities:
{{=parameters.object}} -
changedSince:
{{=parameters.since}}
Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/changedatacapture#get-a-list-of-changed-entities.
- Id
Template: ShortText.
- status
Template: ShortText.
- domain
Template: ShortText.
- MetaData
Template: MetaData.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/class#query-a-class.
- [Create] action
-
Endpoint URL address:
/class.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/class#create-a-class.
- [Update] action
-
Endpoint URL address:
/class.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/class#full-update-a-class.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- ParentRef
Template: Ref.
- SubClass
Data type: DT_BOOL
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
- FullyQualifiedName
Template: ShortText.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/companycurrency#query-a-companycurrency.
- [Create] action
-
Endpoint URL address:
/companycurrency.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/companycurrency#create-a-companycurrency.
- [Update] action
-
Endpoint URL address:
/companycurrency.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/companycurrency#update-a-companycurrency.
- Id
A key field. Template: ShortText.
- Code
Template: ShortText.
- SyncToken
Template: ShortText.
- Name
Template: ShortText.
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditmemo#query-a-credit-memo.
- [Create] action
-
Endpoint URL address:
/creditmemo.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditmemo#create-a-credit-memo.
- [Update] action
-
Endpoint URL address:
/creditmemo.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditmemo#full-update-a-credit-memo.
- [Delete] action
-
Endpoint URL address:
/creditmemo.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditmemo#delete-a-credit-memo.
The resource includes the fields from the CreditMemoT template.
Data type: DT_IMAGE The value is gathered from
/creditmemo/{{=item.Id}}/pdfaddress.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditcardpayment#query-a-creditcardpayment.
- [Create] action
-
Endpoint URL address:
/creditcardpayment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditcardpayment#create-a-creditcardpayment.
- [Update] action
-
Endpoint URL address:
/creditcardpayment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditcardpayment#full-update-a-creditcardpayment.
- [Delete] action
-
Endpoint URL address:
/creditcardpayment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/creditcardpayment#delete-a-creditcardpayment.
- Id
A key field. Template: ShortText.
- CreditCardAccountRef
Template: Ref.
- Amount
Data type: DT_R8
- BankAccountRef
Template: Ref.
- SyncToken
Template: ShortText.
- PrivateNote
Template: LongText.
- VendorRef
Template: Ref.
- TxnDate
Template: DateTime.
- Memo
Template: ShortText.
- PrintStatus
Template: ShortText.
- CheckNum
Template: ShortText.
- CurrencyRef
Template: Ref.
- MetaData
Template: MetaData.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#query-a-customer.
- [Create] action
-
Endpoint URL address:
/customer.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#create-a-customer.
- [Update] action
-
Endpoint URL address:
/customer.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#full-update-a-customer.
- Id
A key field. Template: ShortText.
- SyncToken
Template: ShortText.
- DisplayName
Template: ShortText.
- Title
Template: ShortText.
- GivenName
Template: ShortText.
- MiddleName
Template: ShortText.
- Suffix
Template: ShortText.
- FamilyName
Template: ShortText.
- PrimaryEmailAddr
Template: EmailAddr.
- ResaleNum
Template: ShortText.
- SecondaryTaxIdentifier
Template: ShortText.
- ARAccountRef
Template: Ref.
- DefaultTaxCodeRef
Template: Ref.
- PreferredDeliveryMethod
Template: ShortText.
- GSTIN
Template: ShortText.
- SalesTermRef
Template: Ref.
- CustomerTypeRef
Template: ShortText.
- Fax
Template: PhoneNum.
- BusinessNumber
Template: ShortText.
- BillWithParent
Data type: DT_BOOL
- CurrencyRef
Template: Ref.
- Mobile
Template: PhoneNum.
- Job
Data type: DT_BOOL
- BalanceWithJobs
Data type: DT_R8
- PrimaryPhone
Template: PhoneNum.
- OpenBalanceDate
Template: DateTime.
- Taxable
Data type: DT_BOOL
- AlternatePhone
Template: PhoneNum.
- MetaData
Template: MetaData.
- ParentRef
Template: Ref.
- Notes
Template: LongText.
- WebAddr
Field components:
-
Uses template:
ShortText. - Contains the following components: URI.
-
Uses template:
- Active
Data type: DT_BOOL
- Balance
Data type: DT_R8
- ShipAddr
Template: Address.
- PaymentMethodRef
Template: Ref.
- IsProject
Data type: DT_BOOL
- CompanyName
Template: ShortText.
- PrimaryTaxIdentifier
Template: ShortText.
- GSTRegistrationType
Template: ShortText.
- PrintOnCheckName
Template: ShortText.
- BillAddr
Template: Address.
- FullyQualifiedName
Template: ShortText.
- Level
Data type: DT_I4
- TaxExemptionReasonId
Data type: DT_I4
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customertype#query-a-customertype.
- Id
A key field. Template: ShortText.
- SyncToken
Template: ShortText.
- domain
Template: ShortText.
- Name
Template: ShortText.
- sparse
Data type: DT_BOOL
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/department#query-a-department.
- [Create] action
-
Endpoint URL address:
/department.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/department#create-a-department.
- [Update] action
-
Endpoint URL address:
/department.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/department#full-update-a-department.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- ParentRef
Template: Ref.
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
- FullyQualifiedName
Template: ShortText.
- SubDepartment
Data type: DT_BOOL
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/deposit#query-a-deposit.
- [Create] action
-
Endpoint URL address:
/deposit.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/deposit#create-a-deposit .
- [Update] action
-
Endpoint URL address:
/deposit.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/deposit#full-update-a-deposit.
- [Delete] action
-
Endpoint URL address:
/deposit.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/deposit#delete-a-deposit.
The resource includes the fields from the DepositT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#query-an-employee.
- [Create] action
-
Endpoint URL address:
/employee.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#create-an-employee.
- [Update] action
-
Endpoint URL address:
/employee.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#full-update-an-employee .
- Id
A key field. Template: ShortText.
- SyncToken
Template: ShortText.
- PrimaryAddr
Template: Address.
- PrimaryEmailAddr
Template: EmailAddr.
- DisplayName
Template: ShortText.
- Title
Template: ShortText.
- BillableTime
Data type: DT_BOOL
- GivenName
Template: ShortText.
- BirthDate
Template: DateTime.
- MiddleName
Template: ShortText.
- SSN
Template: ShortText.
- PrimaryPhone
Template: PhoneNum.
- Active
Data type: DT_BOOL
- ReleasedDate
Template: DateTime.
- MetaData
Template: MetaData.
- Mobile
Template: PhoneNum.
- Gender
Template: ShortText.
- HiredDate
Template: DateTime.
- BillRate
Data type: DT_R8
- Organization
Data type: DT_BOOL
- Suffix
Template: ShortText.
- FamilyName
Template: ShortText.
- PrintOnCheckName
Template: ShortText.
- EmployeeNumber
Template: ShortText.
- V4IDPseudonym
Template: ShortText.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#query-an-estimate.
- [Create] action
-
Endpoint URL address:
/estimate.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#create-an-estimate.
- [Update] action
-
Endpoint URL address:
/estimate.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#full-update-an-estimate.
- [Delete] action
-
Endpoint URL address:
/estimate.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#delete-an-estimate.
The resource includes the fields from the EstimateT template.
Data type: DT_IMAGE The value is gathered from
/estimate/{{=item.Id}}/pdfaddress.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/exchangerate#query-exchangerate-objects..
- [Update] action
-
Endpoint URL address:
/exchangerate.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/exchangerate#update-an-exchangerate.
- SyncToken
Template: ShortText.
- AsOfDate
Template: DateTime.
- SourceCurrencyCode
Template: ShortText.
- Rate
Data type: DT_R8
- TargetCurrencyCode
Template: ShortText.
- MetaData
Template: MetaData.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#query-an-invoice.
- [Create] action
-
Endpoint URL address:
/invoice.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#create-an-invoice.
- [Update] action
-
Endpoint URL address:
/invoice.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#full-update-an-invoice.
- [Delete] action
-
Endpoint URL address:
/invoice.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#delete-an-invoice.
The resource includes the fields from the InvoiceT template.
Data type: DT_IMAGE The value is gathered from
/invoice/{{=item.Id}}/pdfaddress.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item#query-an-item.
- [Create] action
-
Endpoint URL address:
/item.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item#create-an-item.
- [Update] action
-
Endpoint URL address:
/item.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item#full-update-an-item.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- InvStartDate
Template: DateTime.
- Type
Template: ShortText.
- QtyOnHand
Data type: DT_I4
- AssetAccountRef
Template: Ref.
- Sku
Template: ShortText.
- SalesTaxIncluded
Data type: DT_BOOL
- TrackQtyOnHand
Data type: DT_BOOL
- SalesTaxCodeRef
Template: Ref.
- ClassRef
Template: Ref.
- PurchaseTaxIncluded
Data type: DT_BOOL
- Description
Template: LongText.
- SubItem
Data type: DT_BOOL
- Taxable
Data type: DT_BOOL
- ReorderPoint
Data type: DT_R8
- PurchaseDesc
Template: ShortText.
- MetaData
Template: MetaData.
- PrefVendorRef
Template: Ref.
- Active
Data type: DT_BOOL
- PurchaseTaxCodeRef
Template: Ref.
- PurchaseCost
Data type: DT_R8
- ParentRef
Template: Ref.
- UnitPrice
Data type: DT_R8
- FullyQualifiedName
Template: ShortText.
- Level
Data type: DT_I4
- IncomeAccountRef
Template: Ref.
- ExpenseAccountRef
Template: Ref.
- TaxClassificationRef
Template: Ref.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- ItemCategoryType
Template: ShortText.
- AbatementRate
Data type: DT_R8
- ReverseChargeRate
Data type: DT_R8
- UQCDisplayText
Template: ShortText.
- UQCId
Template: ShortText.
- ServiceType
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalcode#query-a-journalcode.
- [Create] action
-
Endpoint URL address:
/journalcode.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalcode#create-a-journalcode.
- [Update] action
-
Endpoint URL address:
/journalcode.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalcode#update-a-journalcode.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- Description
Template: LongText.
- Type
Template: ShortText.
- MetaData
Template: MetaData.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- time
Template: ShortText.
- Active
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalentry#query-a-journalentry.
- [Create] action
-
Endpoint URL address:
/journalentry.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalentry#create-a-journalentry.
- [Update] action
-
Endpoint URL address:
/journalentry.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalentry#full-update-a-journalentry.
- [Delete] action
-
Endpoint URL address:
/journalentry.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/journalentry#delete-a-journalentry.
The resource includes the fields from the JournalEntryT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment#query-a-payment.
- [Create] action
-
Endpoint URL address:
/payment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment#create-a-payment.
- [Update] action
-
Endpoint URL address:
/payment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment#full-update-a-payment.
- [Delete] action
-
Endpoint URL address:
/payment.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment#delete-a-payment.
- Id
A key field. Template: ShortText.
- TotalAmt
Data type: DT_R8
- CustomerRef
Template: Ref.
- SyncToken
Template: ShortText.
- CurrencyRef
Template: Ref.
- PrivateNote
Template: LongText.
- PaymentMethodRef
Template: Ref.
- UnappliedAmt
Data type: DT_R8
- DepositToAccountRef
Template: Ref.
- ExchangeRate
Data type: DT_R8
- Line
Field components:
- An array.
- Contains the following components: Amount, LinkedTxn, LineEx.
- TxnSource
Template: ShortText.
- ARAccountRef
Template: Ref.
- TxnDate
Template: DateTime.
- CreditCardPayment
Template: CreditCardPaymentT.
- MetaData
Template: MetaData.
- TaxExemptionRef
Template: Ref.
- ProcessPayment
Data type: DT_BOOL
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- TransactionLocationType
Template: ShortText.
- PaymentRefNum
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/paymentmethod#query-a-paymentmethod.
- [Create] action
-
Endpoint URL address:
/paymentmethod.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/paymentmethod#create-a-paymentmethod.
- [Update] action
-
Endpoint URL address:
/paymentmethod.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/paymentmethod#full-update-a-paymentmethod.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- Active
Data type: DT_BOOL
- Type
Template: ShortText.
- MetaData
Template: MetaData.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchase#query-a-purchase.
- [Create] action
-
Endpoint URL address:
/purchase.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchase#create-a-purchase.
- [Update] action
-
Endpoint URL address:
/purchase.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchase#full-update-a-purchase.
- [Delete] action
-
Endpoint URL address:
/purchase.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchase#delete-a-purchase.
The resource includes the fields from the PurchaseT template.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder#query-a-purchase-order.
- [Create] action
-
Endpoint URL address:
/purchaseorder.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder#create-a-purchase-order.
- [Update] action
-
Endpoint URL address:
/purchaseorder.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder#full-update-a-purchase-order.
- [Delete] action
-
Endpoint URL address:
/purchaseorder.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder#delete-a-purchase-order.
The resource includes the fields from the PurchaseOrderT template.
Data type: DT_IMAGE The value is gathered from
/purchaseorder/{{=item.Id}}/pdfaddress.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/recurringtransaction#query-a-recurring-transaction.
- [Create] action
-
Endpoint URL address:
/recurringtransaction.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/recurringtransaction#create-a-recurring-transaction.
- [Delete] action
-
Endpoint URL address:
/recurringtransaction.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/recurringtransaction#delete-a-recurring-transaction.
- Bill
Template: BillT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- Purchase
Template: PurchaseT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- CreditMemo
Template: CreditMemoT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- Deposit
Template: DepositT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- Estimate
Template: EstimateT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- Invoice
Template: InvoiceT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- JournalEntry
Template: JournalEntryT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- RefundReceipt
Template: RefundReceiptT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- SalesReceipt
Template: SalesReceiptT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- Transfer
Template: TransferT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- VendorCredit
Template: VendorCreditT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
- PurchaseOrder
Template: PurchaseOrderT. Field components:
-
Uses template:
RecurringInfoT. - Contains the following components: RecurringInfo.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/refundreceipt#query-a-refund-receipt.
- [Create] action
-
Endpoint URL address:
/refundreceipt.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/refundreceipt#create-a-refund-receipt.
- [Update] action
-
Endpoint URL address:
/refundreceipt.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/refundreceipt#full-update-a-refund-receipt.
- [Delete] action
-
Endpoint URL address:
/refundreceipt.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/refundreceipt#delete-a-refund-receipt.
The resource includes the fields from the RefundReceiptT template.
Data type: DT_IMAGE The value is gathered from
/refundreceipt/{{=item.Id}}/pdfaddress.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/reimbursecharge#query-a-reimburse-charge.
- Id
Template: ShortText.
- Line
Field components:
- An array.
- Contains the following components: Id, DetailType, LinkedTxn, LineNum, LineId, Amount, ReimburseLineDetail.
- Amount
Data type: DT_R8
- CustomerRef
Template: Ref.
- SyncToken
Template: ShortText.
- CurrencyRef
Template: Ref.
- PrivateNote
Template: LongText.
- LinkedTxn
Field components:
- An array.
-
Uses template:
Txn.
- ExchangeRate
Data type: DT_R8
- MetaData
Template: MetaData.
- HasBeenInvoiced
Data type: DT_BOOL
- HomeTotalAmt
Data type: DT_R8
- TxnDate
Template: DateTime.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#query-a-salesreceipt.
- [Create] action
-
Endpoint URL address:
/salesreceipt.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#create-a-salesreceipt.
- [Update] action
-
Endpoint URL address:
/salesreceipt.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#full-update-a-salesreceipt.
- [Delete] action
-
Endpoint URL address:
/salesreceipt.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/salesreceipt#delete-a-salesreceipt.
The resource includes the fields from the SalesReceiptT template.
Data type: DT_IMAGE The value is gathered from
/salesreceipt/{{=item.Id}}/pdfaddress.
- [External]
-
The external fields list is extracted from:
{{=QB.getCustomFields('Sales')}}.- CustomField.{{=external.name}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/taxclassification.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxclassification#read-all-taxclassifications .
- [Read parent] action
-
Endpoint URL address:
/taxclassification/{{=parameters.parent_id}}/children.The action has the following user-defined parameters:
- parent_id: Required. Specify parent identifier.
Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxclassification#read-a-taxclassification-by-parent-id.
- Id
Template: ShortText.
- ParentRef
Template: Ref.
- applicableTo
Template: LongText. A composite field.
- Code
Template: ShortText.
- Name
Template: ShortText.
- Description
Template: ShortText.
- Level
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxcode#query-a-taxcode.
- Id
Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- PurchaseTaxRateList
Template: TaxRateList.
- SalesTaxRateList
Template: TaxRateList.
- TaxGroup
Data type: DT_BOOL
- Taxable
Data type: DT_BOOL
- Active
Data type: DT_BOOL
- Description
Template: LongText.
- Hidden
Data type: DT_BOOL
- MetaData
Template: MetaData.
- TaxCodeConfigType
Template: ShortText.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxpayment#query-taxpayment.
- Id
Template: ShortText.
- SyncToken
Template: ShortText.
- MetaData
Template: MetaData.
- Refund
Data type: DT_BOOL
- TxnDate
Template: DateTime.
- PaymentAccountRef
Template: Ref.
- Description
Template: LongText.
- PaymentAmount
Data type: DT_R8
- domain
Template: ShortText.
- sparse
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxrate#query-a-taxrate.
- Id
Template: ShortText.
- SyncToken
Template: ShortText.
- RateValue
Data type: DT_R8
- Name
Template: ShortText.
- AgencyRef
Template: Ref.
- SpecialTaxType
Template: ShortText.
- EffectiveTaxRate
Field components:
-
Uses template:
DateTime. - Contains the following components: RateValue, EndDate, EffectiveDate.
-
Uses template:
- DisplayType
Template: ShortText.
- TaxReturnLineRef
Template: Ref.
- Active
Data type: DT_BOOL
- MetaData
Template: MetaData.
- Description
Template: LongText.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxagency#query-a-taxagency.
- [Create] action
-
Endpoint URL address:
taxagency.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/taxagency#create-a-taxagency.
- Id
A key field. Template: ShortText.
- DisplayName
Template: ShortText.
- SyncToken
Template: ShortText.
- TaxTrackedOnSales
Data type: DT_BOOL
- TaxTrackedOnPurchases
Data type: DT_BOOL
- TaxRegistrationNumber
Template: ShortText.
- MetaData
Template: MetaData.
- TaxAgencyConfig
Template: ShortText.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- LastFileDate
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/term#query-a-term.
- [Create] action
-
Endpoint URL address:
/term.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/term#create-a-term.
- [Update] action
-
Endpoint URL address:
/term.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/term#full-update-a-term.
- Id
A key field. Template: ShortText.
- Name
Template: ShortText.
- SyncToken
Template: ShortText.
- DiscountPercent
Data type: DT_R8
- DiscountDays
Data type: DT_I4
- Active
Data type: DT_BOOL
- Type
Template: ShortText.
- MetaData
Template: MetaData.
- DayOfMonthDue
Data type: DT_I4
- DiscountDayOfMonth
Data type: DT_I4
- DueNextMonthDays
Data type: DT_I4
- DueDays
Data type: DT_I4
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/timeactivity#query-a-timeactivity-object.
- [Create] action
-
Endpoint URL address:
/timeactivity.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/timeactivity#create-a-timeactivity-object.
- [Update] action
-
Endpoint URL address:
/timeactivity.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/timeactivity#full-update-a-timeactivity-object.
- [Delete] action
-
Endpoint URL address:
/timeactivity.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/timeactivity#delete-a-timeactivity-object.
- Id
A key field. Template: ShortText.
- NameOf
Template: ShortText.
- SyncToken
Template: ShortText.
- TxnDate
Template: DateTime.
- EmployeeRef
Template: Ref.
- VendorRef
Template: Ref.
- Hours
Data type: DT_I4
- StartTime
Template: DateTime.
- HourlyRate
Data type: DT_R8
- BreakHours
Data type: DT_I4
- BreakMinutes
Data type: DT_I4
- EndTime
Template: DateTime.
- CustomerRef
Template: Ref.
- Description
Template: LongText.
- ItemRef
Template: Ref.
- ClassRef
Template: Ref.
- DepartmentRef
Template: Ref.
- PayrollItemRef
Template: Ref.
- BillableStatus
Template: ShortText.
- Taxable
Data type: DT_BOOL
- MetaData
Template: MetaData.
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- TransactionLocationType
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/transfer#query-an-transfer.
- [Create] action
-
Endpoint URL address:
/transfer.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/transfer#create-an-transfer.
- [Update] action
-
Endpoint URL address:
/transfer.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/transfer#full-update-an-transfer.
- [Delete] action
-
Endpoint URL address:
/transfer.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/transfer#delete-an-transfer.
The resource includes the fields from the TransferT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendor#query-a-vendor.
- [Create] action
-
Endpoint URL address:
/vendor.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendor#create-a-vendor.
- [Update] action
-
Endpoint URL address:
/vendor.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendor#full-update-a-vendor.
- Id
A key field. Template: ShortText.
- SyncToken
Template: ShortText.
- Title
Template: ShortText.
- GivenName
Template: ShortText.
- MiddleName
Template: ShortText.
- Suffix
Template: ShortText.
- FamilyName
Template: ShortText.
- PrimaryEmailAddr
Template: EmailAddr.
- DisplayName
Template: ShortText.
- OtherContactInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: Type, Telephone.
-
Uses template:
- TermRef
Template: Ref.
- Fax
Template: PhoneNum.
- CurrencyRef
Template: Ref.
- Mobile
Template: PhoneNum.
- PrimaryPhone
Template: PhoneNum.
- Active
Data type: DT_BOOL
- AlternatePhone
Template: PhoneNum.
- MetaData
Template: MetaData.
- Vendor1099
Data type: DT_BOOL
- BillRate
Data type: DT_R8
- WebAddr
Field components:
-
Uses template:
ShortText. - Contains the following components: URI.
-
Uses template:
- CompanyName
Template: ShortText.
- TaxIdentifier
Template: ShortText.
- AcctNum
Template: ShortText.
- PrintOnCheckName
Template: ShortText.
- BillAddr
Template: Address.
- Balance
Data type: DT_I4
- domain
Template: ShortText.
- sparse
Data type: DT_BOOL
- APAccountRef
Template: Ref.
- GSTIN
Template: ShortText.
- BusinessNumber
Template: ShortText.
- HasTPAR
Data type: DT_BOOL
- TaxReportingBasis
Template: ShortText.
- VendorPaymentBankDetail
Field components:
-
Uses template:
ShortText. - Contains the following components: BankAccountName, BankBranchIdentifier, BankAccountNumber, StatementText.
-
Uses template:
- GSTRegistrationType
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/query.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendorcredit#query-a-vendorcredit.
- [Create] action
-
Endpoint URL address:
/vendorcredit.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendorcredit#create-a-vendorcredit.
- [Update] action
-
Endpoint URL address:
/vendorcredit.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendorcredit#full-update-a-vendorcredit.
- [Delete] action
-
Endpoint URL address:
/vendorcredit.Documentation: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/vendorcredit#delete-a-vendorcredit.
The resource includes the fields from the VendorCreditT template.
- [Read] action
-
Endpoint URL address:
/reports/{{=parameters.ReportName}}.
The result is extracted from:{{=QB.getReportData(response)}}.The action has the following user-defined parameters:
- ReportName: Required. Specifies report name.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- [External]
-
The external fields URL address:
/reports/{{=parameters.ReportName}}. The external fields list is extracted from:{{=QB.getReportFields(response)}}.
- [Read] action
-
The result is extracted from:{{=response.QueryResponse[resource.object]}}.
The result is paginated.The action has the following user-defined parameters:
- Filter: Specify filter clause. Optional.
The following request parameters will be automatically processed:
-
query:
{{=QB.getQueryStatement(parameters, resource.object)}} -
_includeUserParameters:
{{=parameters}}
- [Create] action
-
The result is extracted from:{{=response[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=_.extend({ Id: item.Id }, item)}}
-
_includeUserParameters:
- [Delete] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
operation:
delete -
application/json:
{{=_.extend({ Id: item.Id }, item)}} -
_includeUserParameters:
{{=parameters}}
-
operation:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- MetaData
Field components:
-
Uses template:
DateTime. - Contains the following components: CreateTime, LastUpdatedTime.
-
Uses template:
- Ref
Field components:
-
Uses template:
ShortText. - Contains the following components: name, value.
-
Uses template:
- EntityRef
Field components:
-
Uses template:
ShortText. - Contains the following components: type, value.
-
Uses template:
- Txn
Field components:
-
Uses template:
ShortText. - Contains the following components: TxnId, TxnType.
-
Uses template:
- Address
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, City, Line1, Line2, Line3, Line4, PostalCode, Lat, Long, CountrySubDivisionCode.
-
Uses template:
- PhoneNum
Field components:
-
Uses template:
ShortText. - Contains the following components: FreeFormNumber.
-
Uses template:
- EmailAddr
Field components:
-
Uses template:
ShortText. - Contains the following components: Address.
-
Uses template:
- MarkupInfo
Field components:
-
Uses template:
Ref. - Contains the following components: PriceLevelRef, Percent, MarkUpIncomeAccountRef.
-
Uses template:
- LineDetail
Field components:
-
Uses template:
Ref. - Contains the following components: ItemRef, ClassRef, TaxCodeRef, MarkupInfo, ItemAccountRef, ServiceDate, Qty, UnitPrice, TaxClassificationRef, TaxInclusiveAmt, DiscountAmt, DiscountRate.
-
Uses template:
- LineT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, DetailType, Amount, Description, LineNum, SalesItemLineDetail, GroupLineDetail, DescriptionLineDetail, DiscountLineDetail, SubtotalLineDetail.
-
Uses template:
- TxnTaxDetail
Field components:
-
Uses template:
Ref. - Contains the following components: TxnTaxCodeRef, TotalTax, TaxLine.
-
Uses template:
- CustomFieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: DefinitionId, StringValue, Type, Name.
-
Uses template:
- ItemEx
Field components:
-
Uses template:
ShortText. - Contains the following components: name, nil, value, declaredType, scope, globalScope, typeSubstituted.
-
Uses template:
- PurchaseLine
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, DetailType, Amount, LinkedTxn, Description, LineNum, ItemBasedExpenseLineDetail, AccountBasedExpenseLineDetail.
-
Uses template:
- RecurringInfoT
Field components:
-
Uses template:
ShortText. - Contains the following components: RecurType, ScheduleInfo, Name, Active.
-
Uses template:
- BillT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, VendorRef, Line, SyncToken, CurrencyRef, TxnDate, APAccountRef, SalesTermRef, LinkedTxn, TotalAmt, DueDate, MetaData, DocNumber, PrivateNote, ExchangeRate, DepartmentRef, HomeBalance, RecurDataRef, Balance, domain, sparse, GlobalTaxCalculation, TransactionLocationType, TxnTaxDetail, IncludeInAnnualTPAR.
-
Uses template:
- PurchaseT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Line, PaymentType, AccountRef, SyncToken, CurrencyRef, TxnDate, PrintStatus, RemitToAddr, TxnSource, LinkedTxn, MetaData, DocNumber, PrivateNote, Credit, TxnTaxDetail, PaymentMethodRef, ExchangeRate, DepartmentRef, EntityRef, TotalAmt, RecurDataRef, PurchaseEx, CustomField, domain, sparse, GlobalTaxCalculation, TransactionLocationType, IncludeInAnnualTPAR.
-
Uses template:
- CreditMemoT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Line, CustomerRef, SyncToken, CurrencyRef, BillEmail, TxnDate, CustomField, ClassRef, PrintStatus, SalesTermRef, TotalAmt, ApplyTaxAfterDiscount, DocNumber, PrivateNote, CustomerMemo, TxnTaxDetail, PaymentMethodRef, ExchangeRate, ShipAddr, DepartmentRef, EmailStatus, BillAddr, MetaData, HomeBalance, RemainingCredit, RecurDataRef, TaxExemptionRef, Balance, HomeTotalAmt, domain, sparse, GlobalTaxCalculation, InvoiceRef, TransactionLocationType.
-
Uses template:
- DepositT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, DepositToAccountRef, Line, SyncToken, CurrencyRef, PrivateNote, GlobalTaxCalculation, ExchangeRate, DepartmentRef, TxnSource, TxnDate, CashBack, TransactionLocationType, TxnTaxDetail, MetaData, RecurDataRef, TotalAmt, HomeTotalAmt, domain, sparse.
-
Uses template:
- EstimateT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, CustomerRef, SyncToken, CurrencyRef, BillEmail, TxnDate, ShipFromAddr, ShipDate, ClassRef, PrintStatus, CustomField, SalesTermRef, TxnStatus, LinkedTxn, GlobalTaxCalculation, AcceptedDate, ExpirationDate, TransactionLocationType, DueDate, MetaData, DocNumber, PrivateNote, Line, CustomerMemo, EmailStatus, TxnTaxDetail, AcceptedBy, ExchangeRate, ShipAddr, DepartmentRef, ShipMethodRef, BillAddr, ApplyTaxAfterDiscount, TotalAmt, RecurDataRef, TaxExemptionRef, HomeTotalAmt, FreeFormAddress, domain, sparse.
-
Uses template:
- InvoiceT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Line, CustomerRef, SyncToken, CurrencyRef, DocNumber, BillEmail, TxnDate, ShipFromAddr, ShipDate, TrackingNum, ClassRef, PrintStatus, SalesTermRef, TxnSource, LinkedTxn, DepositToAccountRef, GlobalTaxCalculation, AllowOnlineACHPayment, TransactionLocationType, DueDate, MetaData, PrivateNote, BillEmailCc, CustomerMemo, EmailStatus, ExchangeRate, Deposit, TxnTaxDetail, AllowOnlineCreditCardPayment, CustomField, ShipAddr, DepartmentRef, BillEmailBcc, ShipMethodRef, BillAddr, ApplyTaxAfterDiscount, HomeBalance, DeliveryInfo, TotalAmt, InvoiceLink, RecurDataRef, TaxExemptionRef, Balance, HomeTotalAmt, FreeFormAddress, domain, sparse.
-
Uses template:
- JournalEntryT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Line, SyncToken, CurrencyRef, DocNumber, PrivateNote, TxnDate, ExchangeRate, TaxRateRef, TxnTaxDetail, Adjustment, MetaData, RecurDataRef, TotalAmt, HomeTotalAmt, domain, sparse, TransactionLocationType, GlobalTaxCalculation.
-
Uses template:
- PurchaseOrderT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, APAccountRef, VendorRef, Line, SyncToken, CurrencyRef, TxnDate, CustomField, POEmail, ClassRef, SalesTermRef, LinkedTxn, Memo, POStatus, DueDate, MetaData, DocNumber, PrivateNote, ShipMethodRef, TxnTaxDetail, ShipTo, ExchangeRate, ShipAddr, VendorAddr, EmailStatus, TotalAmt, RecurDataRef, domain, sparse, GlobalTaxCalculation, TransactionLocationType.
-
Uses template:
- CreditCardPaymentT
Field components:
- Contains the following components: CreditChargeResponse, CreditChargeInfo.
- RefundReceiptT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, DepositToAccountRef, Line, SyncToken, CurrencyRef, PaymentRefNum, BillEmail, TxnDate, CustomField, ClassRef, PrintStatus, CheckPayment, TxnSource, MetaData, DocNumber, PrivateNote, CustomerMemo, CreditCardPayment, CustomerRef, TxnTaxDetail, PaymentMethodRef, ExchangeRate, ShipAddr, DepartmentRef, PaymentType, BillAddr, ApplyTaxAfterDiscount, HomeBalance, RecurDataRef, TotalAmt, TaxExemptionRef, Balance, HomeTotalAmt, domain, sparse, GlobalTaxCalculation, TransactionLocationType.
-
Uses template:
- SalesReceiptT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Line, CustomerRef, SyncToken, CurrencyRef, BillEmail, TxnDate, ShipFromAddr, CustomField, ShipDate, TrackingNum, ClassRef, PrintStatus, PaymentRefNum, TxnSource, ApplyTaxAfterDiscount, DocNumber, PrivateNote, DepositToAccountRef, CustomerMemo, EmailStatus, CreditCardPayment, TxnTaxDetail, PaymentMethodRef, ExchangeRate, ShipAddr, DepartmentRef, ShipMethodRef, BillAddr, MetaData, HomeBalance, DeliveryInfo, RecurDataRef, TotalAmt, Balance, HomeTotalAmt, FreeFormAddress, domain, sparse, GlobalTaxCalculation, TransactionLocationType.
-
Uses template:
- TaxRateList
Field components:
- Contains the following components: TaxRateDetail.
- TransferT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, ToAccountRef, Amount, FromAccountRef, SyncToken, PrivateNote, TxnDate, MetaData, RecurDataRef, domain, sparse, TransactionLocationType.
-
Uses template:
- VendorCreditT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, VendorRef, Line, SyncToken, CurrencyRef, DocNumber, PrivateNote, LinkedTxn, ExchangeRate, APAccountRef, DepartmentRef, TxnDate, Balance, MetaData, RecurDataRef, TotalAmt, domain, sparse, GlobalTaxCalculation, IncludeInAnnualTPAR, TransactionLocationType.
-
Uses template:
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.