QuickBooks Desktop

App · 18 actions

Read QuickBooks Desktop accounting records and manage customers through Conductor.

Actions

ActionWhat it does
Create customerCreate customer in QuickBooks Desktop.
Create vendorCreate vendor in QuickBooks Desktop.
Get accountGet account in QuickBooks Desktop.
Get billGet bill in QuickBooks Desktop.
Get customerGet customer in QuickBooks Desktop.
Get invoiceGet invoice in QuickBooks Desktop.
Get receive paymentGet receive payment in QuickBooks Desktop.
Get sales receiptGet sales receipt in QuickBooks Desktop.
Get vendorGet vendor in QuickBooks Desktop.
List accountsList accounts in QuickBooks Desktop.
List billsList bills in QuickBooks Desktop.
List customersList customers in QuickBooks Desktop.
List invoicesList invoices in QuickBooks Desktop.
List receive paymentsList receive payments in QuickBooks Desktop.
List sales receiptsList sales receipts in QuickBooks Desktop.
List vendorsList vendors in QuickBooks Desktop.
Update customerUpdate customer in QuickBooks Desktop.
Update vendorUpdate vendor in QuickBooks Desktop.

Create customer

Create customer in QuickBooks Desktop.

Inputs

NamenametextRequired
The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like `fullName` does. For example, two customers could both have the `name` "Website Redesign Project", but they could have unique `fullName` values, such as "ABC Corporation:Website Redesign Project" and "Baker:Website Redesign Project". Maximum length: 41 characters.
Is activeis_activetrue/false
Indicates whether this customer is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.Default: true.
Company namecompany_nametext
The name of the company associated with this customer. This name is used on invoices, checks, and other forms. Maximum length: 41 characters.
First namefirst_nametext
The first name of the contact person for this customer. Maximum length: 25 characters.
Last namelast_nametext
The last name of the contact person for this customer. Maximum length: 25 characters.
Phonephonetext
The customer's primary telephone number. Maximum length: 21 characters.
Emailemailtext
The customer's email address. Maximum length: 1023 characters.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "additionalContacts": [],
    "additionalNotes": [],
    "alternateContact": "example",
    "alternatePhone": "example",
    "alternateShippingAddresses": [],
    "balance": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "ccEmail": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "companyName": "example",
    "contact": "example",
    "createdAt": "example",
    "creditCard": {
      "address": "example",
      "expirationMonth": 1.0,
      "expirationYear": 1.0,
      "name": "example",
      "number": "example",
      "postalCode": "example"
    },
    "creditLimit": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customContactFields": [],
    "customFields": [],
    "customerType": {
      "fullName": "example",
      "id": "example"
    },
    "email": "example",
    "externalId": "example",
    "fax": "example",
    "firstName": "example",
    "fullName": "example",
    "id": "example",
    "isActive": false,
    "jobDescription": "example",
    "jobEndDate": "example",
    "jobProjectedEndDate": "example",
    "jobStartDate": "example",
    "jobStatus": "awarded",
    "jobTitle": "example",
    "jobType": {
      "fullName": "example",
      "id": "example"
    },
    "lastName": "example",
    "middleName": "example",
    "name": "example",
    "note": "example",
    "objectType": "qbd_customer",
    "parent": {
      "fullName": "example",
      "id": "example"
    },
    "phone": "example",
    "preferredDeliveryMethod": "email",
    "preferredPaymentMethod": {
      "fullName": "example",
      "id": "example"
    },
    "priceLevel": {
      "fullName": "example",
      "id": "example"
    },
    "resaleNumber": "example",
    "revisionNumber": "example",
    "salesRepresentative": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCountry": "example",
    "salesTaxItem": {
      "fullName": "example",
      "id": "example"
    },
    "salutation": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "sublevel": 1.0,
    "taxRegistrationNumber": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "totalBalance": "example",
    "updatedAt": "example"
  }
}

Create vendor

Create vendor in QuickBooks Desktop.

Inputs

NamenametextRequired
The case-insensitive unique name of this vendor, unique across all vendors. **NOTE**: Vendors do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents. Maximum length: 41 characters.
Is activeis_activetrue/false
Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.Default: true.
Company namecompany_nametext
The name of the company associated with this vendor. This name is used on invoices, checks, and other forms. Maximum length: 41 characters.
First namefirst_nametext
The first name of the contact person for this vendor. Maximum length: 25 characters.
Last namelast_nametext
The last name of the contact person for this vendor. Maximum length: 25 characters.
Phonephonetext
The vendor's primary telephone number. Maximum length: 21 characters.
Emailemailtext
The vendor's email address. Maximum length: 1023 characters.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "additionalContacts": [],
    "additionalNotes": [],
    "alternateContact": "example",
    "alternatePhone": "example",
    "balance": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "billingRate": {
      "fullName": "example",
      "id": "example"
    },
    "ccEmail": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "companyName": "example",
    "contact": "example",
    "createdAt": "example",
    "creditLimit": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customContactFields": [],
    "customFields": [],
    "defaultExpenseAccounts": [],
    "email": "example",
    "externalId": "example",
    "fax": "example",
    "firstName": "example",
    "id": "example",
    "isActive": false,
    "isCompoundingTax": false,
    "isEligibleFor1099": false,
    "isSalesTaxAgency": false,
    "isTrackingPurchaseTax": false,
    "isTrackingSalesTax": false,
    "jobTitle": "example",
    "lastName": "example",
    "middleName": "example",
    "name": "example",
    "nameOnCheck": "example",
    "note": "example",
    "objectType": "qbd_vendor",
    "phone": "example",
    "purchaseTaxAccount": {
      "fullName": "example",
      "id": "example"
    },
    "reportingPeriod": "monthly",
    "revisionNumber": "example",
    "salesTaxAccount": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCountry": "example",
    "salesTaxReturn": {
      "fullName": "example",
      "id": "example"
    },
    "salutation": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "taxIdentificationNumber": "example",
    "taxRegistrationNumber": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "updatedAt": "example",
    "vendorType": {
      "fullName": "example",
      "id": "example"
    }
  }
}

Get account

Get account in QuickBooks Desktop.

Inputs

Accountaccount_idtextRequired
The QuickBooks-assigned unique identifier of the account to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "accountType": "accounts_payable",
    "balance": "example",
    "bankAccountNumber": "example",
    "cashFlowClassification": "financing",
    "createdAt": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customFields": [],
    "description": "example",
    "fullName": "example",
    "id": "example",
    "isActive": false,
    "isTaxAccount": false,
    "name": "example",
    "objectType": "qbd_account",
    "parent": {
      "fullName": "example",
      "id": "example"
    },
    "revisionNumber": "example",
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "specialAccountType": "accounts_payable",
    "sublevel": 1.0,
    "taxLineDetails": {
      "taxLineId": 1.0,
      "taxLineName": "example"
    },
    "totalBalance": "example",
    "updatedAt": "example"
  }
}

Get bill

Get bill in QuickBooks Desktop.

Inputs

Billbill_idtextRequired
The QuickBooks-assigned unique identifier of the bill to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "amountDue": "example",
    "amountDueInHomeCurrency": "example",
    "createdAt": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customFields": [],
    "dueDate": "example",
    "exchangeRate": 1.0,
    "expenseLines": [],
    "externalId": "example",
    "id": "example",
    "isPaid": false,
    "isPending": false,
    "itemGroupLines": [],
    "itemLines": [],
    "linkedTransactions": [],
    "memo": "example",
    "objectType": "qbd_bill",
    "openAmount": "example",
    "payablesAccount": {
      "fullName": "example",
      "id": "example"
    },
    "refNumber": "example",
    "revisionNumber": "example",
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "transactionDate": "example",
    "updatedAt": "example",
    "vendor": {
      "fullName": "example",
      "id": "example"
    },
    "vendorAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    }
  }
}

Get customer

Get customer in QuickBooks Desktop.

Inputs

Customercustomer_idtextRequired
The QuickBooks-assigned unique identifier of the customer to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "additionalContacts": [],
    "additionalNotes": [],
    "alternateContact": "example",
    "alternatePhone": "example",
    "alternateShippingAddresses": [],
    "balance": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "ccEmail": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "companyName": "example",
    "contact": "example",
    "createdAt": "example",
    "creditCard": {
      "address": "example",
      "expirationMonth": 1.0,
      "expirationYear": 1.0,
      "name": "example",
      "number": "example",
      "postalCode": "example"
    },
    "creditLimit": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customContactFields": [],
    "customFields": [],
    "customerType": {
      "fullName": "example",
      "id": "example"
    },
    "email": "example",
    "externalId": "example",
    "fax": "example",
    "firstName": "example",
    "fullName": "example",
    "id": "example",
    "isActive": false,
    "jobDescription": "example",
    "jobEndDate": "example",
    "jobProjectedEndDate": "example",
    "jobStartDate": "example",
    "jobStatus": "awarded",
    "jobTitle": "example",
    "jobType": {
      "fullName": "example",
      "id": "example"
    },
    "lastName": "example",
    "middleName": "example",
    "name": "example",
    "note": "example",
    "objectType": "qbd_customer",
    "parent": {
      "fullName": "example",
      "id": "example"
    },
    "phone": "example",
    "preferredDeliveryMethod": "email",
    "preferredPaymentMethod": {
      "fullName": "example",
      "id": "example"
    },
    "priceLevel": {
      "fullName": "example",
      "id": "example"
    },
    "resaleNumber": "example",
    "revisionNumber": "example",
    "salesRepresentative": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCountry": "example",
    "salesTaxItem": {
      "fullName": "example",
      "id": "example"
    },
    "salutation": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "sublevel": 1.0,
    "taxRegistrationNumber": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "totalBalance": "example",
    "updatedAt": "example"
  }
}

Get invoice

Get invoice in QuickBooks Desktop.

Inputs

Invoiceinvoice_idtextRequired
The QuickBooks-assigned unique identifier of the invoice to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "appliedAmount": "example",
    "balanceRemaining": "example",
    "balanceRemainingInHomeCurrency": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "createdAt": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customFields": [],
    "customer": {
      "fullName": "example",
      "id": "example"
    },
    "customerMessage": {
      "fullName": "example",
      "id": "example"
    },
    "documentTemplate": {
      "fullName": "example",
      "id": "example"
    },
    "dueDate": "example",
    "exchangeRate": 1.0,
    "externalId": "example",
    "id": "example",
    "isFinanceCharge": false,
    "isPaid": false,
    "isPending": false,
    "isQueuedForEmail": false,
    "isQueuedForPrint": false,
    "lineGroups": [],
    "lines": [],
    "linkedTransactions": [],
    "memo": "example",
    "objectType": "qbd_invoice",
    "otherCustomField": "example",
    "purchaseOrderNumber": "example",
    "receivablesAccount": {
      "fullName": "example",
      "id": "example"
    },
    "refNumber": "example",
    "revisionNumber": "example",
    "salesRepresentative": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxItem": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxPercentage": "example",
    "salesTaxTotal": "example",
    "shipmentOrigin": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "shippingDate": "example",
    "shippingMethod": {
      "fullName": "example",
      "id": "example"
    },
    "subtotal": "example",
    "suggestedDiscountAmount": "example",
    "suggestedDiscountDate": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "transactionDate": "example",
    "updatedAt": "example"
  }
}

Get receive payment

Get receive payment in QuickBooks Desktop.

Inputs

Receive paymentreceive_payment_idtextRequired
The QuickBooks-assigned unique identifier of the receive-payment to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "appliedToTransactions": [],
    "createdAt": "example",
    "creditCardTransaction": {
      "request": {
        "address": "example",
        "commercialCardCode": "example",
        "expirationMonth": 1.0,
        "expirationYear": 1.0,
        "name": "example",
        "number": "example",
        "postalCode": "example",
        "transactionMode": "card_not_present",
        "transactionType": "authorization"
      },
      "response": {
        "authorizationCode": "example",
        "avsStreetStatus": "fail",
        "avsZipStatus": "fail",
        "cardSecurityCodeMatch": "fail",
        "clientTransactionId": "example",
        "creditCardTransactionId": "example",
        "merchantAccountNumber": "example",
        "paymentGroupingCode": 1.0,
        "paymentStatus": "completed",
        "reconBatchId": "example",
        "statusCode": 1.0,
        "statusMessage": "example",
        "transactionAuthorizationStamp": 1.0,
        "transactionAuthorizedAt": "example"
      }
    },
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customFields": [],
    "customer": {
      "fullName": "example",
      "id": "example"
    },
    "depositToAccount": {
      "fullName": "example",
      "id": "example"
    },
    "exchangeRate": 1.0,
    "externalId": "example",
    "id": "example",
    "memo": "example",
    "objectType": "qbd_receive_payment",
    "paymentMethod": {
      "fullName": "example",
      "id": "example"
    },
    "receivablesAccount": {
      "fullName": "example",
      "id": "example"
    },
    "refNumber": "example",
    "revisionNumber": "example",
    "totalAmount": "example",
    "totalAmountInHomeCurrency": "example",
    "transactionDate": "example",
    "unusedCredits": "example",
    "unusedPayment": "example",
    "updatedAt": "example"
  }
}

Get sales receipt

Get sales receipt in QuickBooks Desktop.

Inputs

Sales receiptsales_receipt_idtextRequired
The QuickBooks-assigned unique identifier of the sales receipt to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "checkNumber": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "createdAt": "example",
    "creditCardTransaction": {
      "request": {
        "address": "example",
        "commercialCardCode": "example",
        "expirationMonth": 1.0,
        "expirationYear": 1.0,
        "name": "example",
        "number": "example",
        "postalCode": "example",
        "transactionMode": "card_not_present",
        "transactionType": "authorization"
      },
      "response": {
        "authorizationCode": "example",
        "avsStreetStatus": "fail",
        "avsZipStatus": "fail",
        "cardSecurityCodeMatch": "fail",
        "clientTransactionId": "example",
        "creditCardTransactionId": "example",
        "merchantAccountNumber": "example",
        "paymentGroupingCode": 1.0,
        "paymentStatus": "completed",
        "reconBatchId": "example",
        "statusCode": 1.0,
        "statusMessage": "example",
        "transactionAuthorizationStamp": 1.0,
        "transactionAuthorizedAt": "example"
      }
    },
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customFields": [],
    "customer": {
      "fullName": "example",
      "id": "example"
    },
    "customerMessage": {
      "fullName": "example",
      "id": "example"
    },
    "depositToAccount": {
      "fullName": "example",
      "id": "example"
    },
    "documentTemplate": {
      "fullName": "example",
      "id": "example"
    },
    "dueDate": "example",
    "exchangeRate": 1.0,
    "externalId": "example",
    "id": "example",
    "isPending": false,
    "isQueuedForEmail": false,
    "isQueuedForPrint": false,
    "lineGroups": [],
    "lines": [],
    "memo": "example",
    "objectType": "qbd_sales_receipt",
    "otherCustomField": "example",
    "paymentMethod": {
      "fullName": "example",
      "id": "example"
    },
    "refNumber": "example",
    "revisionNumber": "example",
    "salesRepresentative": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxItem": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxPercentage": "example",
    "salesTaxTotal": "example",
    "shipmentOrigin": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "shippingDate": "example",
    "shippingMethod": {
      "fullName": "example",
      "id": "example"
    },
    "subtotal": "example",
    "totalAmount": "example",
    "totalAmountInHomeCurrency": "example",
    "transactionDate": "example",
    "updatedAt": "example"
  }
}

Get vendor

Get vendor in QuickBooks Desktop.

Inputs

Vendorvendor_idtextRequired
The QuickBooks-assigned unique identifier of the vendor to retrieve.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "additionalContacts": [],
    "additionalNotes": [],
    "alternateContact": "example",
    "alternatePhone": "example",
    "balance": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "billingRate": {
      "fullName": "example",
      "id": "example"
    },
    "ccEmail": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "companyName": "example",
    "contact": "example",
    "createdAt": "example",
    "creditLimit": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customContactFields": [],
    "customFields": [],
    "defaultExpenseAccounts": [],
    "email": "example",
    "externalId": "example",
    "fax": "example",
    "firstName": "example",
    "id": "example",
    "isActive": false,
    "isCompoundingTax": false,
    "isEligibleFor1099": false,
    "isSalesTaxAgency": false,
    "isTrackingPurchaseTax": false,
    "isTrackingSalesTax": false,
    "jobTitle": "example",
    "lastName": "example",
    "middleName": "example",
    "name": "example",
    "nameOnCheck": "example",
    "note": "example",
    "objectType": "qbd_vendor",
    "phone": "example",
    "purchaseTaxAccount": {
      "fullName": "example",
      "id": "example"
    },
    "reportingPeriod": "monthly",
    "revisionNumber": "example",
    "salesTaxAccount": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCountry": "example",
    "salesTaxReturn": {
      "fullName": "example",
      "id": "example"
    },
    "salutation": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "taxIdentificationNumber": "example",
    "taxRegistrationNumber": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "updatedAt": "example",
    "vendorType": {
      "fullName": "example",
      "id": "example"
    }
  }
}

List accounts

List accounts in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for accounts, so this parameter only limits the response size. When this parameter is omitted, the endpoint returns all accounts without limit, unlike paginated endpoints which default to 150 records.At least 1.
Updated afterupdated_aftertext
Filter for accounts updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Name containsname_containstext
Filter for accounts whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "objectType": "list",
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List bills

List bills in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.From 1 to 150. Default: 150.
Cursorcursortext
The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. **IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.
Updated afterupdated_aftertext
Filter for bills updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "nextCursor": "example",
    "objectType": "list",
    "remainingCount": 1.0,
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List customers

List customers in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.From 1 to 150. Default: 150.
Cursorcursortext
The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. **IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
Updated afterupdated_aftertext
Filter for customers updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Name containsname_containstext
Filter for customers whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "nextCursor": "example",
    "objectType": "list",
    "remainingCount": 1.0,
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List invoices

List invoices in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.From 1 to 150. Default: 150.
Cursorcursortext
The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. **IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.
Updated afterupdated_aftertext
Filter for invoices updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "nextCursor": "example",
    "objectType": "list",
    "remainingCount": 1.0,
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List receive payments

List receive payments in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.From 1 to 150. Default: 150.
Cursorcursortext
The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. **IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.
Updated afterupdated_aftertext
Filter for receive-payments updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "nextCursor": "example",
    "objectType": "list",
    "remainingCount": 1.0,
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List sales receipts

List sales receipts in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.From 1 to 150. Default: 150.
Cursorcursortext
The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. **IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.
Updated afterupdated_aftertext
Filter for sales receipts updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "nextCursor": "example",
    "objectType": "list",
    "remainingCount": 1.0,
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List vendors

List vendors in QuickBooks Desktop.

Inputs

Limitlimitnumber
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.From 1 to 150. Default: 150.
Cursorcursortext
The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. **IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
Updated afterupdated_aftertext
Filter for vendors updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Name containsname_containstext
Filter for vendors whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.

Outputs

dataobject
Quick Books Desktop response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "nextCursor": "example",
    "objectType": "list",
    "remainingCount": 1.0,
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Update customer

Update customer in QuickBooks Desktop.

Inputs

Customercustomer_idtextRequired
The QuickBooks-assigned unique identifier of the customer to update.
Revision numberrevision_numbertextRequired
The current QuickBooks-assigned revision number of the customer object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.
Namenametext
The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like `fullName` does. For example, two customers could both have the `name` "Website Redesign Project", but they could have unique `fullName` values, such as "ABC Corporation:Website Redesign Project" and "Baker:Website Redesign Project". Maximum length: 41 characters.
Is activeis_activetrue/false
Indicates whether this customer is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.
Company namecompany_nametext
The name of the company associated with this customer. This name is used on invoices, checks, and other forms. Maximum length: 41 characters.
First namefirst_nametext
The first name of the contact person for this customer. Maximum length: 25 characters.
Last namelast_nametext
The last name of the contact person for this customer. Maximum length: 25 characters.
Phonephonetext
The customer's primary telephone number. Maximum length: 21 characters.
Emailemailtext
The customer's email address. Maximum length: 1023 characters.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "additionalContacts": [],
    "additionalNotes": [],
    "alternateContact": "example",
    "alternatePhone": "example",
    "alternateShippingAddresses": [],
    "balance": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "ccEmail": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "companyName": "example",
    "contact": "example",
    "createdAt": "example",
    "creditCard": {
      "address": "example",
      "expirationMonth": 1.0,
      "expirationYear": 1.0,
      "name": "example",
      "number": "example",
      "postalCode": "example"
    },
    "creditLimit": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customContactFields": [],
    "customFields": [],
    "customerType": {
      "fullName": "example",
      "id": "example"
    },
    "email": "example",
    "externalId": "example",
    "fax": "example",
    "firstName": "example",
    "fullName": "example",
    "id": "example",
    "isActive": false,
    "jobDescription": "example",
    "jobEndDate": "example",
    "jobProjectedEndDate": "example",
    "jobStartDate": "example",
    "jobStatus": "awarded",
    "jobTitle": "example",
    "jobType": {
      "fullName": "example",
      "id": "example"
    },
    "lastName": "example",
    "middleName": "example",
    "name": "example",
    "note": "example",
    "objectType": "qbd_customer",
    "parent": {
      "fullName": "example",
      "id": "example"
    },
    "phone": "example",
    "preferredDeliveryMethod": "email",
    "preferredPaymentMethod": {
      "fullName": "example",
      "id": "example"
    },
    "priceLevel": {
      "fullName": "example",
      "id": "example"
    },
    "resaleNumber": "example",
    "revisionNumber": "example",
    "salesRepresentative": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCountry": "example",
    "salesTaxItem": {
      "fullName": "example",
      "id": "example"
    },
    "salutation": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "sublevel": 1.0,
    "taxRegistrationNumber": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "totalBalance": "example",
    "updatedAt": "example"
  }
}

Update vendor

Update vendor in QuickBooks Desktop.

Inputs

Vendorvendor_idtextRequired
The QuickBooks-assigned unique identifier of the vendor to update.
Revision numberrevision_numbertextRequired
The current QuickBooks-assigned revision number of the vendor object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.
Namenametext
The case-insensitive unique name of this vendor, unique across all vendors. **NOTE**: Vendors do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents. Maximum length: 41 characters.
Is activeis_activetrue/false
Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.
Company namecompany_nametext
The name of the company associated with this vendor. This name is used on invoices, checks, and other forms. Maximum length: 41 characters.
First namefirst_nametext
The first name of the contact person for this vendor. Maximum length: 25 characters.
Last namelast_nametext
The last name of the contact person for this vendor. Maximum length: 25 characters.
Phonephonetext
The vendor's primary telephone number. Maximum length: 21 characters.
Emailemailtext
The vendor's email address. Maximum length: 1023 characters.

Outputs

dataobject
Quick Books Desktop response data.
Example output
{
  "data": {
    "accountNumber": "example",
    "additionalContacts": [],
    "additionalNotes": [],
    "alternateContact": "example",
    "alternatePhone": "example",
    "balance": "example",
    "billingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "billingRate": {
      "fullName": "example",
      "id": "example"
    },
    "ccEmail": "example",
    "class": {
      "fullName": "example",
      "id": "example"
    },
    "companyName": "example",
    "contact": "example",
    "createdAt": "example",
    "creditLimit": "example",
    "currency": {
      "fullName": "example",
      "id": "example"
    },
    "customContactFields": [],
    "customFields": [],
    "defaultExpenseAccounts": [],
    "email": "example",
    "externalId": "example",
    "fax": "example",
    "firstName": "example",
    "id": "example",
    "isActive": false,
    "isCompoundingTax": false,
    "isEligibleFor1099": false,
    "isSalesTaxAgency": false,
    "isTrackingPurchaseTax": false,
    "isTrackingSalesTax": false,
    "jobTitle": "example",
    "lastName": "example",
    "middleName": "example",
    "name": "example",
    "nameOnCheck": "example",
    "note": "example",
    "objectType": "qbd_vendor",
    "phone": "example",
    "purchaseTaxAccount": {
      "fullName": "example",
      "id": "example"
    },
    "reportingPeriod": "monthly",
    "revisionNumber": "example",
    "salesTaxAccount": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCode": {
      "fullName": "example",
      "id": "example"
    },
    "salesTaxCountry": "example",
    "salesTaxReturn": {
      "fullName": "example",
      "id": "example"
    },
    "salutation": "example",
    "shippingAddress": {
      "city": "example",
      "country": "example",
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "line4": "example",
      "line5": "example",
      "note": "example",
      "postalCode": "example",
      "state": "example"
    },
    "taxIdentificationNumber": "example",
    "taxRegistrationNumber": "example",
    "terms": {
      "fullName": "example",
      "id": "example"
    },
    "updatedAt": "example",
    "vendorType": {
      "fullName": "example",
      "id": "example"
    }
  }
}

On this page