searchRecords

READ

Search one QuickBooks entity (customers, vendors, accounts, departments, classes, items, invoices, credit memos, payments, journal entries, deposits, bills) fo….

POST /api/v1/quickbooks/searchRecords

curl -X POST '<your-host>/api/v1/quickbooks/searchRecords' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": "Customer"
  }'

Response

{
  "results": [
    {
      "…": "…"
    }
  ],
  "count": null
}

Parameters

ParameterType

The QuickBooks entity, by the name Intuit's API gives it.

"Customer""Vendor""Account""Department""Class""Item""Invoice""CreditMemo""Payment""JournalEntry""Deposit""Bill"

Conditions every record must meet, joined with AND. QuickBooks answers Customer, Vendor, Account, Department, Class and Item with their active records only unless a criterion names Active; { "field": "Active", "operator": "IN", "value": [true, false] } includes the inactive ones.

How many records at most, up to 1,000.

min 1max 1000

"ASC""DESC"

A property of the entity, a dotted path such as MetaData.CreateTime. Commonly filtered: Customer: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DisplayName, GivenName, FamilyName, CompanyName, PrimaryEmailAddr, PrimaryPhone, Balance, Active; Vendor: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, GivenName, MiddleName, FamilyName, CompanyName, DisplayName, PrintOnCheckName, Active, PrimaryPhone, AlternatePhone, Mobile, Fax, PrimaryEmailAddr, WebAddr, Title, Balance, BillRate, AcctNum, Vendor1099; Account: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, SubAccount, ParentRef, Description, Active, Classification, AccountType, CurrentBalance; Department: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Class: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Item: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active, Type, Sku; Invoice: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate, DueDate, CustomerRef, ClassRef, DepartmentRef, Balance, TotalAmt; CreditMemo: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; Payment: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; JournalEntry: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate; Deposit: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, TxnDate; Bill: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, TxnDate, DueDate, Balance, TotalAmt, VendorRef, APAccountRef, DocNumber, PrivateNote, ExchangeRate, DepartmentRef, CurrencyRef.

pattern ^[A-Za-z][A-Za-z0-9]*(\.[A-Za-z][A-Za-z0-9]*)*$

The first record's position, from 1.

min 1max 9007199254740991

Input schema

schema

{
  "type": "object",
  "properties": {
    "entity": {
      "type": "string",
      "enum": [
        "Customer",
        "Vendor",
        "Account",
        "Department",
        "Class",
        "Item",
        "Invoice",
        "CreditMemo",
        "Payment",
        "JournalEntry",
        "Deposit",
        "Bill"
      ],
      "description": "The QuickBooks entity, by the name Intuit's API gives it."
    },
    "criteria": {
      "default": [],
      "description": "Conditions every record must meet, joined with AND. QuickBooks answers Customer, Vendor, Account, Department, Class and Item with their active records only unless a criterion names Active; { \"field\": \"Active\", \"operator\": \"IN\", \"value\": [true, false] } includes the inactive ones.",
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "field": {
                "type": "string",
                "pattern": "^[A-Za-z][A-Za-z0-9]*(\\.[A-Za-z][A-Za-z0-9]*)*$",
                "description": "A property of the entity, a dotted path such as MetaData.CreateTime. Commonly filtered: Customer: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DisplayName, GivenName, FamilyName, CompanyName, PrimaryEmailAddr, PrimaryPhone, Balance, Active; Vendor: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, GivenName, MiddleName, FamilyName, CompanyName, DisplayName, PrintOnCheckName, Active, PrimaryPhone, AlternatePhone, Mobile, Fax, PrimaryEmailAddr, WebAddr, Title, Balance, BillRate, AcctNum, Vendor1099; Account: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, SubAccount, ParentRef, Description, Active, Classification, AccountType, CurrentBalance; Department: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Class: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Item: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active, Type, Sku; Invoice: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate, DueDate, CustomerRef, ClassRef, DepartmentRef, Balance, TotalAmt; CreditMemo: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; Payment: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; JournalEntry: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate; Deposit: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, TxnDate; Bill: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, TxnDate, DueDate, Balance, TotalAmt, VendorRef, APAccountRef, DocNumber, PrivateNote, ExchangeRate, DepartmentRef, CurrencyRef."
              },
              "operator": {
                "type": "string",
                "enum": [
                  "=",
                  "<",
                  ">",
                  "<=",
                  ">=",
                  "LIKE"
                ]
              },
              "value": {
                "description": "The value compared with; LIKE takes % as its wildcard.",
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              }
            },
            "required": [
              "field",
              "operator",
              "value"
            ]
          },
          {
            "type": "object",
            "properties": {
              "field": {
                "type": "string",
                "pattern": "^[A-Za-z][A-Za-z0-9]*(\\.[A-Za-z][A-Za-z0-9]*)*$",
                "description": "A property of the entity, a dotted path such as MetaData.CreateTime. Commonly filtered: Customer: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DisplayName, GivenName, FamilyName, CompanyName, PrimaryEmailAddr, PrimaryPhone, Balance, Active; Vendor: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, GivenName, MiddleName, FamilyName, CompanyName, DisplayName, PrintOnCheckName, Active, PrimaryPhone, AlternatePhone, Mobile, Fax, PrimaryEmailAddr, WebAddr, Title, Balance, BillRate, AcctNum, Vendor1099; Account: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, SubAccount, ParentRef, Description, Active, Classification, AccountType, CurrentBalance; Department: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Class: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Item: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active, Type, Sku; Invoice: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate, DueDate, CustomerRef, ClassRef, DepartmentRef, Balance, TotalAmt; CreditMemo: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; Payment: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; JournalEntry: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate; Deposit: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, TxnDate; Bill: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, TxnDate, DueDate, Balance, TotalAmt, VendorRef, APAccountRef, DocNumber, PrivateNote, ExchangeRate, DepartmentRef, CurrencyRef."
              },
              "operator": {
                "type": "string",
                "const": "IN"
              },
              "value": {
                "minItems": 1,
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "number"
                    },
                    {
                      "type": "boolean"
                    }
                  ]
                },
                "description": "The values any one matches."
              }
            },
            "required": [
              "field",
              "operator",
              "value"
            ]
          }
        ]
      }
    },
    "orderBy": {
      "type": "object",
      "properties": {
        "field": {
          "type": "string",
          "pattern": "^[A-Za-z][A-Za-z0-9]*(\\.[A-Za-z][A-Za-z0-9]*)*$",
          "description": "A property of the entity, a dotted path such as MetaData.CreateTime. Commonly filtered: Customer: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DisplayName, GivenName, FamilyName, CompanyName, PrimaryEmailAddr, PrimaryPhone, Balance, Active; Vendor: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, GivenName, MiddleName, FamilyName, CompanyName, DisplayName, PrintOnCheckName, Active, PrimaryPhone, AlternatePhone, Mobile, Fax, PrimaryEmailAddr, WebAddr, Title, Balance, BillRate, AcctNum, Vendor1099; Account: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, SubAccount, ParentRef, Description, Active, Classification, AccountType, CurrentBalance; Department: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Class: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active; Item: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, Name, Active, Type, Sku; Invoice: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate, DueDate, CustomerRef, ClassRef, DepartmentRef, Balance, TotalAmt; CreditMemo: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; Payment: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, CustomerRef, TxnDate; JournalEntry: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, DocNumber, TxnDate; Deposit: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, TxnDate; Bill: Id, MetaData.CreateTime, MetaData.LastUpdatedTime, SyncToken, TxnDate, DueDate, Balance, TotalAmt, VendorRef, APAccountRef, DocNumber, PrivateNote, ExchangeRate, DepartmentRef, CurrencyRef."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      },
      "required": [
        "field",
        "direction"
      ]
    },
    "startPosition": {
      "default": 1,
      "description": "The first record's position, from 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "maxResults": {
      "default": 100,
      "description": "How many records at most, up to 1,000.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "entity"
  ]
}