> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.quickbooks.accounting.FindCustomer

- Component: `appmixer.quickbooks.accounting.FindCustomer`
- Kind: Action
- Version: 1.0.2
- Visibility: Public
- Connector: [appmixer.quickbooks 1.9.0](https://connectors.appmixer.com/connector/appmixer.quickbooks/1.9.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.quickbooks/1.9.0/component/appmixer.quickbooks.accounting.FindCustomer>

Find a customer in your QuickBooks.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Filter (`filter`) | expression | Filter by customer property. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Customer Primary Email Addr Address (`Customer.PrimaryEmailAddr.Address`) | string | - |
| Customer Sync Token (`Customer.SyncToken`) | string | - |
| Customer Domain (`Customer.domain`) | string | - |
| Customer Given Name (`Customer.GivenName`) | string | - |
| Customer Display Name (`Customer.DisplayName`) | string | - |
| Customer Bill With Parent (`Customer.BillWithParent`) | boolean | - |
| Customer Fully Qualified Name (`Customer.FullyQualifiedName`) | string | - |
| Customer Company Name (`Customer.CompanyName`) | string | - |
| Customer Family Name (`Customer.FamilyName`) | string | - |
| Customer Sparse (`Customer.sparse`) | boolean | - |
| Customer Primary Phone Free Form Number (`Customer.PrimaryPhone.FreeFormNumber`) | string | - |
| Customer Active (`Customer.Active`) | boolean | - |
| Customer Job (`Customer.Job`) | boolean | - |
| Customer Balance With Jobs (`Customer.BalanceWithJobs`) | number | - |
| Customer Bill Addr City (`Customer.BillAddr.City`) | string | - |
| Customer Bill Addr Line 1 (`Customer.BillAddr.Line1`) | string | - |
| Customer Bill Addr Line 2 (`Customer.BillAddr.Line2`) | string | - |
| Customer Bill Addr Line 3 (`Customer.BillAddr.Line3`) | string | - |
| Customer Bill Addr Line 4 (`Customer.BillAddr.Line4`) | string | - |
| Customer Bill Addr Line 5 (`Customer.BillAddr.Line5`) | string | - |
| Customer Bill Addr Postal Code (`Customer.BillAddr.PostalCode`) | string | - |
| Customer Bill Addr Lat (`Customer.BillAddr.Lat`) | string | - |
| Customer Bill Addr Long (`Customer.BillAddr.Long`) | string | - |
| Customer Bill Addr Country Sub Division Code (`Customer.BillAddr.CountrySubDivisionCode`) | string | - |
| Customer Bill Addr Country (`Customer.BillAddr.Country`) | string | - |
| Customer Bill Addr Id (`Customer.BillAddr.Id`) | string | - |
| Customer Ship Addr City (`Customer.ShipAddr.City`) | string | - |
| Customer Ship Addr Line 5 (`Customer.ShipAddr.Line5`) | string | - |
| Customer Ship Addr Line 4 (`Customer.ShipAddr.Line4`) | string | - |
| Customer Ship Addr Line 3 (`Customer.ShipAddr.Line3`) | string | - |
| Customer Ship Addr Line 2 (`Customer.ShipAddr.Line2`) | string | - |
| Customer Ship Addr Line 1 (`Customer.ShipAddr.Line1`) | string | - |
| Customer Ship Addr Postal Code (`Customer.ShipAddr.PostalCode`) | string | - |
| Customer Ship Addr Lat (`Customer.ShipAddr.Lat`) | string | - |
| Customer Ship Addr Long (`Customer.ShipAddr.Long`) | string | - |
| Customer Ship Addr Country Sub Division Code (`Customer.ShipAddr.CountrySubDivisionCode`) | string | - |
| Customer Ship Addr Country (`Customer.ShipAddr.Country`) | string | - |
| Customer Ship Addr Id (`Customer.ShipAddr.Id`) | string | - |
| Customer Preferred Delivery Method (`Customer.PreferredDeliveryMethod`) | string | - |
| Customer Taxable (`Customer.Taxable`) | boolean | - |
| Customer Print On Check Name (`Customer.PrintOnCheckName`) | string | - |
| Customer Balance (`Customer.Balance`) | number | - |
| Customer Id (`Customer.Id`) | string | - |
| Customer Meta Data Create Time (`Customer.MetaData.CreateTime`) | string | - |
| Customer Meta Data Last Updated Time (`Customer.MetaData.LastUpdatedTime`) | string | - |
| Time (`time`) | string | - |

### Port `notFound`

| Field | Type | Description |
| --- | --- | --- |
| Search Query (`query`) | string | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.quickbooks.accounting.FindCustomer",
  "author": "Harsha Surisetty <harsha@client.io>",
  "description": "Find a customer in your QuickBooks.",
  "version": "1.0.2",
  "auth": {
    "service": "appmixer:quickbooks",
    "scope": [
      "com.intuit.quickbooks.accounting",
      "openid",
      "profile",
      "email",
      "phone",
      "address"
    ]
  },
  "inPorts": [
    {
      "name": "in",
      "inspector": {
        "inputs": {
          "filter": {
            "type": "expression",
            "label": "Filter",
            "levels": [
              "AND"
            ],
            "index": 1,
            "tooltip": "Filter by customer property.",
            "fields": {
              "property": {
                "type": "select",
                "label": "Property",
                "index": 1,
                "tooltip": "Select a property/attribute name to filter.",
                "options": [
                  {
                    "label": "Display Name",
                    "value": "DisplayName"
                  },
                  {
                    "label": "Given Name",
                    "value": "GivenName"
                  },
                  {
                    "label": "Middle Name",
                    "value": "MiddleName"
                  },
                  {
                    "label": "Family Name",
                    "value": "FamilyName"
                  },
                  {
                    "label": "Primary Email Address",
                    "value": "PrimaryEmailAddr"
                  },
                  {
                    "label": "Fully Qualified Name",
                    "value": "FullyQualifiedName"
                  },
                  {
                    "label": "Company Name",
                    "value": "CompanyName"
                  },
                  {
                    "label": "Primary Phone Number",
                    "value": "PrimaryPhoneNumber"
                  },
                  {
                    "label": "Mobile Phone Number",
                    "value": "MobilePhoneNumber"
                  },
                  {
                    "label": "Alternate Phone Number",
                    "value": "AlternatePhoneNumber"
                  },
                  {
                    "label": "Fax Number",
                    "value": "FaxNumber"
                  },
                  {
                    "label": "Address",
                    "value": "Address"
                  },
                  {
                    "label": "Resale Number",
                    "value": "ResaleNumber"
                  },
                  {
                    "label": "Primary Tax Identifier",
                    "value": "PrimaryTaxIdentifier"
                  },
                  {
                    "label": "Secondary Tax Identifier",
                    "value": "SecondaryTaxIdentifier"
                  },
                  {
                    "label": "AR Account Value",
                    "value": "ArAccountValue"
                  },
                  {
                    "label": "AR Account Name",
                    "value": "ArAccountName"
                  },
                  {
                    "label": "GSTIN",
                    "value": "Gstin"
                  },
                  {
                    "label": "GST Registration Type",
                    "value": "GstRegistrationType"
                  },
                  {
                    "label": "Customer Type",
                    "value": "CustomerType"
                  },
                  {
                    "label": "Business Number",
                    "value": "BusinessNumber"
                  },
                  {
                    "label": "Open Balance Date",
                    "value": "OpenBalanceDate"
                  },
                  {
                    "label": "Create Time",
                    "value": "CreateTime"
                  },
                  {
                    "label": "Last Updated Time",
                    "value": "LastUpdatedTime"
                  },
                  {
                    "label": "Notes",
                    "value": "Notes"
                  },
                  {
                    "label": "Website Address",
                    "value": "WebsiteAddress"
                  },
                  {
                    "label": "Balance",
                    "value": "Balance"
                  },
                  {
                    "label": "Ship Address Line 1",
                    "value": "ShipAddressLine1"
                  },
                  {
                    "label": "Ship Address Line 2",
                    "value": "ShipAddressLine2"
                  },
                  {
                    "label": "Ship Address City",
                    "value": "ShipAddressCity"
                  },
                  {
                    "label": "Ship Address Postal Code",
                    "value": "ShipAddressPostalCode"
                  },
                  {
                    "label": "Bill Address Line 1",
                    "value": "BillAddressLine1"
                  },
                  {
                    "label": "Bill Address Line 2",
                    "value": "BillAddressLine2"
                  },
                  {
                    "label": "Bill Address City",
                    "value": "BillAddressCity"
                  },
                  {
                    "label": "Bill Address Postal Code",
                    "value": "BillAddressPostalCode"
                  }
                ]
              },
              "operator": {
                "type": "select",
                "label": "Operator",
                "index": 2,
                "tooltip": "Provide a name of the signer.",
                "options": [
                  {
                    "label": "=",
                    "value": "="
                  },
                  {
                    "label": "<",
                    "value": "<"
                  },
                  {
                    "label": ">",
                    "value": ">"
                  },
                  {
                    "label": "<=",
                    "value": "<="
                  },
                  {
                    "label": ">=",
                    "value": ">="
                  },
                  {
                    "label": "IN",
                    "value": "IN"
                  },
                  {
                    "label": "LIKE",
                    "value": "LIKE"
                  }
                ]
              },
              "value": {
                "type": "text",
                "label": "Value",
                "index": 3,
                "tooltip": "Provide an attribute value."
              }
            }
          }
        }
      },
      "schema": {
        "type": "object",
        "properties": {
          "filter": {
            "type": "object"
          }
        },
        "required": [
          "filter"
        ]
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "options": [
        {
          "label": "Customer Primary Email Addr Address",
          "value": "Customer.PrimaryEmailAddr.Address",
          "schema": {
            "type": "string",
            "example": "bill@example.com"
          }
        },
        {
          "label": "Customer Sync Token",
          "value": "Customer.SyncToken",
          "schema": {
            "type": "string",
            "example": "0"
          }
        },
        {
          "label": "Customer Domain",
          "value": "Customer.domain",
          "schema": {
            "type": "string",
            "example": "QBO"
          }
        },
        {
          "label": "Customer Given Name",
          "value": "Customer.GivenName",
          "schema": {
            "type": "string",
            "example": "Bill"
          }
        },
        {
          "label": "Customer Display Name",
          "value": "Customer.DisplayName",
          "schema": {
            "type": "string",
            "example": "Bill's Windsurf Shop"
          }
        },
        {
          "label": "Customer Bill With Parent",
          "value": "Customer.BillWithParent",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Customer Fully Qualified Name",
          "value": "Customer.FullyQualifiedName",
          "schema": {
            "type": "string",
            "example": "Bill's Windsurf Shop"
          }
        },
        {
          "label": "Customer Company Name",
          "value": "Customer.CompanyName",
          "schema": {
            "type": "string",
            "example": "Bill's Windsurf Shop"
          }
        },
        {
          "label": "Customer Family Name",
          "value": "Customer.FamilyName",
          "schema": {
            "type": "string",
            "example": "Lucchini"
          }
        },
        {
          "label": "Customer Sparse",
          "value": "Customer.sparse",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Customer Primary Phone Free Form Number",
          "value": "Customer.PrimaryPhone.FreeFormNumber",
          "schema": {
            "type": "string",
            "example": "(415) 555-0142"
          }
        },
        {
          "label": "Customer Active",
          "value": "Customer.Active",
          "schema": {
            "type": "boolean",
            "example": true
          }
        },
        {
          "label": "Customer Job",
          "value": "Customer.Job",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Customer Balance With Jobs",
          "value": "Customer.BalanceWithJobs",
          "schema": {
            "type": "number",
            "example": 85
          }
        },
        {
          "label": "Customer Bill Addr City",
          "value": "Customer.BillAddr.City",
          "schema": {
            "type": "string",
            "example": "Half Moon Bay"
          }
        },
        {
          "label": "Customer Bill Addr Line 1",
          "value": "Customer.BillAddr.Line1",
          "schema": {
            "type": "string",
            "example": "12 Ocean Dr."
          }
        },
        {
          "label": "Customer Bill Addr Line 2",
          "value": "Customer.BillAddr.Line2",
          "schema": {
            "type": "string",
            "example": "Suite 200"
          }
        },
        {
          "label": "Customer Bill Addr Line 3",
          "value": "Customer.BillAddr.Line3",
          "schema": {
            "type": "string",
            "example": ""
          }
        },
        {
          "label": "Customer Bill Addr Line 4",
          "value": "Customer.BillAddr.Line4",
          "schema": {
            "type": "string",
            "example": ""
          }
        },
        {
          "label": "Customer Bill Addr Line 5",
          "value": "Customer.BillAddr.Line5",
          "schema": {
            "type": "string",
            "example": ""
          }
        },
        {
          "label": "Customer Bill Addr Postal Code",
          "value": "Customer.BillAddr.PostalCode",
          "schema": {
            "type": "string",
            "example": "94213"
          }
        },
        {
          "label": "Customer Bill Addr Lat",
          "value": "Customer.BillAddr.Lat",
          "schema": {
            "type": "string",
            "example": "37.4307072"
          }
        },
        {
          "label": "Customer Bill Addr Long",
          "value": "Customer.BillAddr.Long",
          "schema": {
            "type": "string",
            "example": "-122.4295234"
          }
        },
        {
          "label": "Customer Bill Addr Country Sub Division Code",
          "value": "Customer.BillAddr.CountrySubDivisionCode",
          "schema": {
            "type": "string",
            "example": "CA"
          }
        },
        {
          "label": "Customer Bill Addr Country",
          "value": "Customer.BillAddr.Country",
          "schema": {
            "type": "string",
            "example": "USA"
          }
        },
        {
          "label": "Customer Bill Addr Id",
          "value": "Customer.BillAddr.Id",
          "schema": {
            "type": "string",
            "example": "3"
          }
        },
        {
          "label": "Customer Ship Addr City",
          "value": "Customer.ShipAddr.City",
          "schema": {
            "type": "string",
            "example": "Half Moon Bay"
          }
        },
        {
          "label": "Customer Ship Addr Line 5",
          "value": "Customer.ShipAddr.Line5",
          "schema": {
            "type": "string",
            "example": ""
          }
        },
        {
          "label": "Customer Ship Addr Line 4",
          "value": "Customer.ShipAddr.Line4",
          "schema": {
            "type": "string",
            "example": ""
          }
        },
        {
          "label": "Customer Ship Addr Line 3",
          "value": "Customer.ShipAddr.Line3",
          "schema": {
            "type": "string",
            "example": ""
          }
        },
        {
          "label": "Customer Ship Addr Line 2",
          "value": "Customer.ShipAddr.Line2",
          "schema": {
            "type": "string",
            "example": "Suite 200"
          }
        },
        {
          "label": "Customer Ship Addr Line 1",
          "value": "Customer.ShipAddr.Line1",
          "schema": {
            "type": "string",
            "example": "12 Ocean Dr."
          }
        },
        {
          "label": "Customer Ship Addr Postal Code",
          "value": "Customer.ShipAddr.PostalCode",
          "schema": {
            "type": "string",
            "example": "94213"
          }
        },
        {
          "label": "Customer Ship Addr Lat",
          "value": "Customer.ShipAddr.Lat",
          "schema": {
            "type": "string",
            "example": "37.4307072"
          }
        },
        {
          "label": "Customer Ship Addr Long",
          "value": "Customer.ShipAddr.Long",
          "schema": {
            "type": "string",
            "example": "-122.4295234"
          }
        },
        {
          "label": "Customer Ship Addr Country Sub Division Code",
          "value": "Customer.ShipAddr.CountrySubDivisionCode",
          "schema": {
            "type": "string",
            "example": "CA"
          }
        },
        {
          "label": "Customer Ship Addr Country",
          "value": "Customer.ShipAddr.Country",
          "schema": {
            "type": "string",
            "example": "USA"
          }
        },
        {
          "label": "Customer Ship Addr Id",
          "value": "Customer.ShipAddr.Id",
          "schema": {
            "type": "string",
            "example": "4"
          }
        },
        {
          "label": "Customer Preferred Delivery Method",
          "value": "Customer.PreferredDeliveryMethod",
          "schema": {
            "type": "string",
            "example": "Print"
          }
        },
        {
          "label": "Customer Taxable",
          "value": "Customer.Taxable",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Customer Print On Check Name",
          "value": "Customer.PrintOnCheckName",
          "schema": {
            "type": "string",
            "example": "Bill's Windsurf Shop"
          }
        },
        {
          "label": "Customer Balance",
          "value": "Customer.Balance",
          "schema": {
            "type": "number",
            "example": 85
          }
        },
        {
          "label": "Customer Id",
          "value": "Customer.Id",
          "schema": {
            "type": "string",
            "example": "2"
          }
        },
        {
          "label": "Customer Meta Data Create Time",
          "value": "Customer.MetaData.CreateTime",
          "schema": {
            "type": "string",
            "example": "2024-09-11T16:49:28-07:00"
          }
        },
        {
          "label": "Customer Meta Data Last Updated Time",
          "value": "Customer.MetaData.LastUpdatedTime",
          "schema": {
            "type": "string",
            "example": "2024-09-18T12:56:01-07:00"
          }
        },
        {
          "label": "Time",
          "value": "time",
          "schema": {
            "type": "string",
            "example": "2024-09-18T12:56:01.123-07:00"
          }
        }
      ]
    },
    {
      "name": "notFound",
      "options": [
        {
          "label": "Search Query",
          "value": "query",
          "schema": {
            "type": "string",
            "example": "SELECT * FROM Customer WHERE DisplayName = 'Bill''s Windsurf Shop' MAXRESULTS 1"
          }
        }
      ]
    }
  ],
  "icon": "(data URI omitted)"
}
```
