QuickBooks Online

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all Accounts

This example lists all the Accountsassociated with the Current application of QB Online entity.

1. In the Configure connector task dialog, click Entities.
2. Select Accounts from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes ('). For example, BillId='25'. You can also specify multiple filter conditions by using the logic operators. For example, BillId='25' and Active=false.

Example - Get a record

This example gets a record with the specified ID from the Bills entity.

1. In the Configure connector task dialog, click Entities.
2. Select Bills from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 220 in the Default Value field.

   Here, 220 is a primary key value in the Bills entity.

Example - Create a record

This example creates a record in the Vendors entity.

1. In the Configure connector task dialog, click Entities.
2. Select Vendors from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   {
     {
       "Id": "32",
       "SyncToken": "0",
       "MetaData_CreateTime": "2024-04-17 17:13:24.0",
       "MetaData_LastUpdatedTime": "2024-04-24 19:55:23.0",
       "Title": null,
       "GivenName": null,
       "MiddleName": null,
       "FamilyName": null,
       "Suffix": null,
       "DisplayName": "tim Telephone",
       "CompanyName": "tim Telephone",
       "PrintOnCheckName": "tim Telephone",
       "Active": true,
       "PrimaryPhone_FreeFormNumber": "(650) 555-1616",
       "AlternatePhone_FreeFormNumber": null,
       "Mobile_FreeFormNumber": null,
       "Fax_FreeFormNumber": null,
       "PrimaryEmailAddr_Address": null,
       "WebAddr_URI": null,
       "BillAddr_Id": "33",
       "BillAddr_Line1": "10 Main St.",
       "BillAddr_Line2": null,
       "BillAddr_Line3": null,
       "BillAddr_Line4": null,
       "BillAddr_Line5": null,
       "BillAddr_City": "Palo Alto",
       "BillAddr_Country": null,
       "BillAddr_CountrySubDivisionCode": "CA",
       "BillAddr_PostalCode": "94303",
       "BillAddr_Lat": "37.445013",
       "BillAddr_Long": "-122.1391443",
       "OtherContactInfo_Type": null,
       "OtherContactInfo_Telephone_FreeFormNumber": null,
       "TaxIdentifier": null,
       "TermRef": "1",
       "TermRef_Name": null,
       "Balance": "0",
       "AcctNum": null,
       "Vendor1099": false,
       "CurrencyRef": "USD",
       "CurrencyRef_Name": "United States Dollar"
     }
   }

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

   {
   { "Id": "64" }
   }

Example - Update a record

This example updates the record with the specified ID in the Purchases entity.

1. In the Configure connector task dialog, click Entities.
2. Select Teams from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   {
   "PrivateNote": "Update"
   }
   }

5. Click entityId, and then enter 22 in the Default Value field.

   Here, 22 is a primary key value in the Purchases entity.

Example - Delete a record

This example deletes the record with the specified ID in the Invoices entity.

1. In the Configure connector task dialog, click Entities.
2. Select Invoices from the Entity list.
3. Select the Delete operation, and then click Done.
4. Click entityId, and then enter 10 in the Default Value field.

   Here, 10 is a primary key value in the Purchases entity.

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

   {
   {Success}
   }