> ## Documentation Index > Fetch the complete documentation index at: https://docs.qubesync.com/llms.txt > Use this file to discover all available pages before exploring further. # List entities > qbXML: `EntityQueryRq`. Queries for the specified entity or entities. A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Intuit's reference: [EntityQuery](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/entityquery). ## OpenAPI ````yaml /api-reference/v2/openapi.json get /connections/{connection_id}/entities openapi: 3.1.0 info: contact: email: support@qubesync.com description: > A single generic operation surface for every curated qbXML request QuBe Sync supports, driven directly off the qbXML schema -- see the [MCP server](/mcp-server) to explore available operations interactively. **Every endpoint queues a request and returns it immediately (`201`, a `QueuedRequest`).** QuickBooks Desktop is reached through the customer's Web Connector, which polls QuBe Sync, so the answer arrives seconds to minutes later. **Pass a `webhook_url` with every request**: when QuickBooks has answered, QuBe Sync POSTs the same document to it -- `state` set, `response_json` filled in -- signed with `X-QUBE-Signature` (see the Webhooks guide). `response_json` is the `{status, data}` envelope documented on each operation: `status: "success"` with `data` derived from the qbXML `*Ret` (and `warning`, QuickBooks' code and message, when it carried the request out but warned about it), or `status: "error"` with QuickBooks' own status code and message -- a QuickBooks business error is a *successful* HTTP round trip. `links.self` returns the request on demand (for a dashboard, a retry, a script); it is not the integration path. Send an `Idempotency-Key` header with each request so a call whose answer you never got can be sent again without queueing it twice. Authentication is HTTP Basic with your app's API key as the username and a blank password. Connections themselves (creating one, onboarding, its QWC file and password) are the `/connections` endpoints; every QuickBooks operation is scoped to one of them. title: QuBe Sync API (v2) version: 2.0.0 servers: - description: v2 API url: https://qubesync.com/api/v2 - description: Local development server url: https://dev.qubesync.com/api/v2 security: - apiKey: [] tags: - description: >- Creating and managing the connection (a customer's QuickBooks company file) that every request below is queued against. See the Onboarding guide. name: Connections - description: >- Queueing qbXML you wrote yourself, listing the requests queued on a connection, and discarding one the app no longer wants. A `webhook_url` on each request is the integration path (see the Webhooks guide): the listing is for a dashboard, a script, or catching up after downtime. name: Queued Requests - description: >- Finding the record in a customer's company file that a name means, even written differently: ranked matches from QuBe Sync's index of the file's names, on realtime and simulated connections. See the Matching guide. name: Matching - description: >- Endpoints for publishing workflow definitions, starting runs, and answering a run that is waiting on a decision from your app. A workflow is one JSON statechart document; see the schema at /api/v2/workflows/schema.json. name: Workflows - name: Account Tax Line Infos - name: Accounts - name: Aging Reports - name: Alerts - name: Ar Refund Credit Cards - name: Bar Codes - name: Bill Payment Checks - name: Bill Payment Credit Cards - name: Bill To Pays - name: Billing Rates - name: Bills - name: Budget Summary Reports - name: Build Assemblies - name: Charges - name: Checks - name: Classes - name: Cleared Statuses - name: Companies - name: Company Activities - name: Credit Card Charges - name: Credit Card Credits - name: Credit Memos - name: Currencies - name: Custom Detail Reports - name: Custom Summary Reports - name: Customer Msgs - name: Customer Types - name: Customers - name: Data Event Recovery Infos - name: Data Ext Defs - name: Data Exts - name: Date Driven Terms - name: Deposits - name: Employee Defaults - name: Employees - name: Entities - name: Estimates - name: Form1099 Category Account Mappings - name: General Detail Reports - name: General Summary Reports - name: Hosts - name: Inventory Adjustments - name: Inventory Sites - name: Invoices - name: Item Assemblies Can Builds - name: Item Discounts - name: Item Fixed Assets - name: Item Groups - name: Item Inventories - name: Item Inventory Assemblies - name: Item Non Inventories - name: Item Other Charges - name: Item Payments - name: Item Receipts - name: Item Sales Tax Groups - name: Item Sales Taxes - name: Item Services - name: Item Sites - name: Item Subtotals - name: Items - name: Job Reports - name: Job Types - name: Journal Entries - name: Leads - name: List Deleteds - name: List Displays - name: List Merge - name: Lists - name: Other Names - name: Paychecks - name: Payment Methods - name: Payments - name: Payroll Detail Reports - name: Payroll Item Additions - name: Payroll Item Company Contributions - name: Payroll Item Deductions - name: Payroll Item Direct Deposits - name: Payroll Item Non Wages - name: Payroll Item Taxes - name: Payroll Item Wages - name: Payroll Item Workers Compensations - name: Payroll Items - name: Payroll Last Periods - name: Payroll Liability Adjustments - name: Payroll Liability Checks - name: Payroll Prior Payments - name: Payroll Summary Reports - name: Payroll Year To Date Adjustments - name: Preferences - name: Price Levels - name: Purchase Orders - name: Qb Command Exec - name: Receive Payment To Deposits - name: Receive Payments - name: Sales Orders - name: Sales Receipts - name: Sales Reps - name: Sales Tax Codes - name: Sales Tax Payables - name: Sales Tax Payment Checks - name: Sales Tax Return Lines - name: Sales Tax Returns - name: Ship Methods - name: Special Accounts - name: Special Items - name: Standard Terms - name: Templates - name: Terms - name: Time Reports - name: Time Trackings - name: To Dos - name: Transactions - name: Transfer Inventories - name: Transfers - name: Txn Deleteds - name: Txn Displays - name: Txn Void - name: Txns - name: Unit Of Measure Sets - name: Vehicle Mileages - name: Vehicles - name: Vendor Credits - name: Vendor Types - name: Vendors - name: Workers Comp Codes paths: /connections/{connection_id}/entities: get: tags: - Entities summary: List entities description: >- qbXML: `EntityQueryRq`. Queries for the specified entity or entities. A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Intuit's reference: [EntityQuery](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/entityquery). operationId: listEntities parameters: - description: >- The connection (a customer's QuickBooks company file) this request is queued for. in: path name: connection_id required: true schema: format: uuid type: string - description: >- Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`. in: query name: request_id required: false schema: type: string - description: >- Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing. in: query name: meta_data required: false schema: enum: - MetaDataAndResponseData - MetaDataOnly - NoMetaData type: string - description: >- Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records; send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `full_name` or `list_id` every match comes back in one answer, so leave `iterator` out. in: query name: iterator required: false schema: type: boolean - description: >- Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: active_status required: false schema: enum: - ActiveOnly - All - InactiveOnly type: string - description: >- Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: from_modified_date required: false schema: format: date-time type: string - description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: full_name required: false schema: items: type: string type: array - in: query name: include_ret_element required: false schema: items: enum: - AccountNumber - AdditionalContactRef - AdditionalNotesRet - AdjustedServiceDate - AltContact - AltPhone - Balance - BillAddress - BillAddressBlock - BillingRateRef - BirthDate - Cc - ClassRef - CompanyName - Contact - ContactsRet - CreditCardInfo - CreditLimit - CurrencyRef - CustomerTypeRef - DataExtRet - DeliveryMethod - Department - Description - DisabilityDesc - Disabled - EditSequence - Email - EmergencyContacts - EmployeeAddress - EmployeePayrollInfo - EmployeeType - Ethnicity - Exempt - ExternalGUID - Fax - FirstName - FullName - Gender - HiredDate - IsActive - IsSalesTaxAgency - IsStatementWithParent - IsTaxAgency - IsTaxOnTax - IsTaxTrackedOnPurchases - IsTaxTrackedOnSales - IsVendorEligibleFor1099 - ItemSalesTaxRef - JobDesc - JobEndDate - JobProjectedEndDate - JobStartDate - JobStatus - JobTitle - JobTypeRef - KeyEmployee - LastName - ListID - MiddleName - MilitaryStatus - Mobile - Name - NameOnCheck - Notes - OnFile - OriginalHireDate - OtherNameAddress - OtherNameAddressBlock - Pager - PagerPIN - ParentRef - PartOrFullTime - Phone - PreferredDeliveryMethod - PreferredPaymentMethodRef - PrefillAccountRef - PriceLevelRef - PrintAs - ReleasedDate - ReportingPeriod - ResaleNumber - SSN - SalesRepRef - SalesTaxCodeRef - SalesTaxCountry - SalesTaxReturnRef - Salutation - ShipAddress - ShipAddressBlock - ShipToAddress - Sublevel - Suffix - SupervisorRef - TargetBonus - TaxOnPurchasesAccountRef - TaxOnSalesAccountRef - TaxRegistrationNumber - TermsRef - TimeCreated - TimeModified - TotalBalance - USCitizen - USVeteran - VendorAddress - VendorAddressBlock - VendorTaxIdent - VendorTypeRef - WorkAuthExpireDate type: string type: array - description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: list_id required: false schema: items: type: string type: array - description: >- Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1. The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: max_returned required: false schema: minimum: 1 type: integer - description: >- Filters according to the object’s Name. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: name_filter required: false schema: properties: match_criterion: description: The criterion to match. enum: - Contains - EndsWith - StartsWith type: string name: description: The string to match. type: string required: - match_criterion - name type: object - description: >- Filters according to the object’s Name. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: name_range_filter required: false schema: properties: from_name: description: >- The first name or item in the search range. If `from_name` is omitted, the range will begin with first name on the list. type: string to_name: description: >- The final name or item in the search range. If `to_name` is omitted, the range will end with last name on the list. type: string type: object - description: >- Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59). Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices. in: query name: to_modified_date required: false schema: format: date-time type: string - description: >- Where QuBe Sync POSTs the answered request (this same document with `response_json` filled in), signed with `X-QUBE-Signature`. Send one with every request: it is how answers are delivered. Optional only so a script can queue and look up `links.self` by hand. It must be an absolute http or https URL. It may not contain a username or password, and in production it may not point at localhost or a private, loopback or link-local address. A `qube listen` URL must be one of this app's. in: query name: webhook_url required: false schema: format: uri maxLength: 2048 type: string - $ref: '#/components/parameters/IdempotencyKey' responses: '201': content: application/json: schema: properties: data: allOf: - $ref: '#/components/schemas/QueuedRequest' - properties: response_json: anyOf: - $ref: >- #/components/schemas/listEntities_response_json - type: 'null' description: '`null` until answered.' type: object required: - data type: object description: >- Queued for the connection's Web Connector. Pass `webhook_url` and QuBe Sync POSTs the answer to it once QuickBooks has answered (see the `answered` callback: its own payload, not this document). `links.self` returns this document on demand, with `response_json` filled in. headers: Idempotent-Replayed: $ref: '#/components/headers/IdempotentReplayed' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/SandboxPaused' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/UnprocessableEntity' callbacks: answered: '{$request.query.webhook_url}': post: description: > Verify `X-QUBE-Signature`, answer 2xx within 5 seconds, then branch on `state`: * `response_received` -- QuickBooks accepted it: `response_json` is `status: "success"` with `data`, or, when there is nothing to show, QuickBooks' `message` (a query that matched nothing is a success, not an error). When QuickBooks carried it out but warned about something, `response_json.warning` has its `code` and `message`: `530`, for one, means a field you sent is not supported by the customer's QuickBooks and was not saved. * `error` -- it is over, and QuBe Sync won't try again. With `error.error_type` `quickbooks_business_error`, QuickBooks refused the request: `response_json` is `status: "error"`, and `response_json.error.code` is the status code to branch on. A `3200` (`stale_edit_sequence`: the record changed after you read it) usually comes with the record as it stands in `response_json.error.current`, its current `edit_sequence` included. Compare it with what you read first: when nobody else changed a field your update sets, re-apply your change and send it again with that `edit_sequence`; when someone did, ask your user which value wins rather than overwriting theirs (without `current`, query the record first). Otherwise QuickBooks never answered it: `xml_error` (the request itself was rejected, and will be again as sent), `outcome_unknown` (a write the Web Connector answered with an error in place of QuickBooks' answer: it may have been applied, so look in QuickBooks before sending it again) or `unexpected_error` (the Web Connector's log says more; a query can be sent again). A connection problem never ends here; it is `retryable`, below. * `retryable` -- the Web Connector could not get it into QuickBooks (QuickBooks was not running, the company file was not open or not this connection's, or a window in QuickBooks was in the way), so nothing was applied. QuBe Sync keeps trying on the Web Connector's runs, so don't resend: show the customer `error.user_message` so they can fix it. This webhook comes when the error first appears or changes, not on every try. If you no longer want the request, discard it (`POST /connections/{connection_id}/queued-requests/{id}/discard`). * `timed_out` -- no answer came back: the customer's computer lost its connection, or QuickBooks or the Web Connector was closed, while QuickBooks had the request. QuickBooks may still have applied it, so look before sending it again. `error.error_type` is `timed_out`. * `discarded` -- your app discarded it before the Web Connector picked it up. QuickBooks never got it, so nothing was applied. `error.error_type` is `discarded`, unless it was `retryable` when you discarded it: then `error` is still the connection error that held it up. An iterated query sends one webhook per page, all with the same `id` and each with its own `page_request_id` and `page`; `iteration_state` is `done` on the last page, which can arrive before earlier ones, so the import is complete once every page from 1 to the `done` page's `page` has been handled. Deliveries can arrive out of order and, after a retry, more than once: key on `page_request_id` plus `state`. A `retryable` webhook is not final: the answer that follows carries the same `id` and `page_request_id` with a different `state`, and only a repeat of the same `state` is a duplicate. A body that would be over 1 MB comes without `response_xml`: `response_xml_omitted` is true, and `links.self` is where to GET it; `response_json` is always there. If webhooks stop arriving altogether, the Web Connector on the customer's PC has most likely stopped calling in; requests wait until it does. Intuit's guide to its errors: https://quickbooks.intuit.com/learn-support/en-us/help-article/open-programs/fix-common-web-connector-errors-quickbooks-desktop/L9slolvg0_US_en_US requestBody: content: application/json: schema: description: >- POSTed to `webhook_url` as JSON, signed with `X-QUBE-Signature` (`t=,v1=." with your app's webhook secret>`). properties: app_id: description: Your app's id. format: uuid type: string app_name: type: string error: description: >- Set when `state` is `error`, `retryable`, `timed_out` or `discarded`. `error_type` says where it failed: for a `timed_out` request it is `timed_out`, and for a `discarded` one `discarded`, unless the request was `retryable` when your app discarded it, which keeps the connection error that held it up. `user_message` is safe to show an end user; `error_code` is QuickBooks' own status code for a business error, `hresult` the Web Connector's for a connection/XML error; `debug_message` is for you. properties: debug_message: description: >- Which element of the request the value came from, when known. type: - string - 'null' error_code: description: QuickBooks' statusCode, for a business error. type: - integer - 'null' error_type: description: >- `quickbooks_business_error`: QuickBooks refused the request -- `response_json.error` has its code. `quickbooks_connection_error`: the Web Connector ran on the customer's PC but could not get the request into QuickBooks, so nothing was applied -- QuickBooks was not running, the company file was not open or not the one this connection belongs to, or a window or message box open in QuickBooks was in the way. Only the customer can fix that, and `user_message` tells them how. `xml_error`: QuickBooks could not parse the qbXML; sent again as-is, it fails again. `outcome_unknown`: a write the Web Connector answered with an error in place of QuickBooks' answer, so whether QuickBooks applied it is not known: look in QuickBooks before sending it again. `unexpected_error`: anything else; for a query, which changes nothing, sending it again is safe. `timed_out`: no answer came back -- the customer's computer lost its connection, or QuickBooks or the Web Connector was closed, while QuickBooks had the request. QuickBooks may still have applied it, so look before sending it again. `discarded`: your app discarded it before the Web Connector picked it up, so QuickBooks never got it. `response_too_large`: QuickBooks answered, but with more than QuBe Sync accepts for one answer (4 MB as the Web Connector sends it, about 3 MB of qbXML), so the answer wasn't kept and `response_json` is null. QuickBooks ran the request. Page the query (`iterator` and a smaller `max_returned`), or narrow it when QuickBooks doesn't page it; for a write, look before sending it again. Web Connector problems on the customer's PC (its password, log file, the .QWC file) never reach QuBe Sync as an error: the Web Connector just stops calling in, and requests wait. Intuit's guide for those: https://quickbooks.intuit.com/learn-support/en-us/help-article/open-programs/fix-common-web-connector-errors-quickbooks-desktop/L9slolvg0_US_en_US enum: - xml_error - quickbooks_connection_error - quickbooks_business_error - unexpected_error - response_too_large - outcome_unknown - timed_out - discarded type: string hresult: description: >- The Web Connector's HRESULT (e.g. `0x80040400`), for a connection or XML error. Informational: branch on `error_type`, not on this. type: - string - 'null' message: description: >- The raw message from QuickBooks or the Web Connector; for `timed_out` and `discarded`, which neither sent, QuBe Sync's own. type: string user_message: description: A friendly message for the end user. type: string type: - object - 'null' id: description: >- The request's id, as the 201 returned it. For an iterated query, every page carries the first page's id here. format: uuid type: string iteration_state: description: >- `continue`: more pages will follow, each its own webhook. `done`: this was the last page. `max_sandbox_iterations_reached`: a sandbox app's page limit stopped the iteration. enum: - not_applicable - continue - done - max_sandbox_iterations_reached type: string links: description: Present only with `response_xml_omitted`. properties: self: description: >- This page's request in the API, `response_xml` included. format: uri type: string type: object page: description: The page number, when iterated. type: - integer - 'null' page_request_id: description: >- This page's own id. Equal to `id` except on later pages of an iterated query. format: uuid type: string response_json: $ref: '#/components/schemas/listEntities_response_json' response_xml: description: >- QuickBooks' raw qbXML answer. `response_json` is the same, summarized. One answer can be at most 4 MB as the Web Connector sends it, about 3 MB of qbXML; QuickBooks' answer over that isn't kept: this is null and `error.error_type` is `response_too_large`. A webhook whose body would be over 1 MB is sent without it: null, with `response_xml_omitted` true; fetch it from `links.self`. type: - string - 'null' response_xml_omitted: description: >- Present, and true, only when `response_xml` was left out to keep the body under 1 MB. `response_json` is still here; GET `links.self` for `response_xml`. type: boolean sandbox: description: Whether the app is a sandbox app. type: boolean state: description: >- `response_received`: QuickBooks accepted it; read `response_json`. `error`: it is over and QuBe Sync won't try again -- see `error`, and `response_json.error` for a QuickBooks business error; with `error_type` `outcome_unknown` a write may still have been applied, so look before sending it again. `retryable`: QuickBooks could not be reached and QuBe Sync keeps trying; show the customer `error.user_message` so they can fix it. `timed_out`: no answer came back -- the customer's computer lost its connection, or QuickBooks or the Web Connector was closed, mid-request. QuickBooks may still have applied it, so look before sending it again. `discarded`: your app discarded it before the Web Connector picked it up, so QuickBooks never got it. Both carry an `error`. enum: - response_received - error - retryable - timed_out - discarded type: string timestamp: description: Unix seconds; the same `t` the signature covers. type: integer required: - app_id - app_name - sandbox - timestamp - id - page_request_id - state - response_json - error type: object required: true responses: 2XX: description: >- Received. Anything else is retried with backoff for about 8 hours. summary: QuickBooks answered (or the request failed) method: post type: path path: '{$request.query.webhook_url}' components: parameters: IdempotencyKey: description: >- Makes a retry safe when you never got the answer to a call: a timeout, a dropped connection, a worker that crashed. Send a new key (a UUID, say) with each request you mean to make once, and the same key when you send that request again. A repeat with the key and the same method, path, query and body answers `201` with what the first call created, as it is now, marked `Idempotent-Replayed: true`, and queues nothing. The same key with a different request is a `422`. A key belongs to your app (sandbox and production apps never share one), lasts as long as what it created, and is 1 to 255 printable ASCII characters. example: 9b2f6c1e-0d4a-4f7e-8a7b-2a1c3d4e5f60 in: header name: Idempotency-Key required: false schema: maxLength: 255 minLength: 1 pattern: ^[\x20-\x7E]+$ type: string schemas: QueuedRequest: properties: error: description: >- Set when `state` is `error`, `retryable`, `timed_out` or `discarded`. `error_type` says where it failed: for a `timed_out` request it is `timed_out`, and for a `discarded` one `discarded`, unless the request was `retryable` when your app discarded it, which keeps the connection error that held it up. `user_message` is safe to show an end user; `error_code` is QuickBooks' own status code for a business error, `hresult` the Web Connector's for a connection/XML error; `debug_message` is for you. properties: debug_message: description: Which element of the request the value came from, when known. type: - string - 'null' error_code: description: QuickBooks' statusCode, for a business error. type: - integer - 'null' error_type: description: >- `quickbooks_business_error`: QuickBooks refused the request -- `response_json.error` has its code. `quickbooks_connection_error`: the Web Connector ran on the customer's PC but could not get the request into QuickBooks, so nothing was applied -- QuickBooks was not running, the company file was not open or not the one this connection belongs to, or a window or message box open in QuickBooks was in the way. Only the customer can fix that, and `user_message` tells them how. `xml_error`: QuickBooks could not parse the qbXML; sent again as-is, it fails again. `outcome_unknown`: a write the Web Connector answered with an error in place of QuickBooks' answer, so whether QuickBooks applied it is not known: look in QuickBooks before sending it again. `unexpected_error`: anything else; for a query, which changes nothing, sending it again is safe. `timed_out`: no answer came back -- the customer's computer lost its connection, or QuickBooks or the Web Connector was closed, while QuickBooks had the request. QuickBooks may still have applied it, so look before sending it again. `discarded`: your app discarded it before the Web Connector picked it up, so QuickBooks never got it. `response_too_large`: QuickBooks answered, but with more than QuBe Sync accepts for one answer (4 MB as the Web Connector sends it, about 3 MB of qbXML), so the answer wasn't kept and `response_json` is null. QuickBooks ran the request. Page the query (`iterator` and a smaller `max_returned`), or narrow it when QuickBooks doesn't page it; for a write, look before sending it again. Web Connector problems on the customer's PC (its password, log file, the .QWC file) never reach QuBe Sync as an error: the Web Connector just stops calling in, and requests wait. Intuit's guide for those: https://quickbooks.intuit.com/learn-support/en-us/help-article/open-programs/fix-common-web-connector-errors-quickbooks-desktop/L9slolvg0_US_en_US enum: - xml_error - quickbooks_connection_error - quickbooks_business_error - unexpected_error - response_too_large - outcome_unknown - timed_out - discarded type: string hresult: description: >- The Web Connector's HRESULT (e.g. `0x80040400`), for a connection or XML error. Informational: branch on `error_type`, not on this. type: - string - 'null' message: description: >- The raw message from QuickBooks or the Web Connector; for `timed_out` and `discarded`, which neither sent, QuBe Sync's own. type: string user_message: description: A friendly message for the end user. type: string type: - object - 'null' id: description: Unique identifier for the queued request format: uuid type: string inserted_at: description: When the request was queued format: date-time type: string iteration_state: description: >- Whether this response is part of an ongoing iteration, and if so, whether more pages remain. Use this (not `state`) to tell whether a multi-page response is complete. enum: - not_applicable - continue - done - max_sandbox_iterations_reached type: string links: properties: connection_ui: format: uri type: string pages: description: >- The pages of a multi-page (iterated) response answered so far, oldest first, a page of them at a time (`page`, `page_size`), each with its own `iteration_state`. Each page is also delivered to `webhook_url` as it is answered. format: uri type: string self: description: >- This request, on demand (a dashboard link, a retry). The answer itself arrives at `webhook_url`. format: uri type: string ui: description: The request in the QuBe Sync dashboard. format: uri type: string required: - self - ui - connection_ui - pages type: object original_request_id: description: >- The id of the first page of this request's iteration. Equal to `id` on the first page itself. format: uuid type: string page: description: The page number, for a multi-page (iterated) response nullable: true type: integer request_types: description: The qbXML request type(s) compiled into this request items: type: string type: array request_xml: description: >- The qbXML sent to QuickBooks: compiled from the operation and its parameters, or as written for `POST /connections/{connection_id}/queued-requests`. A character above ASCII reaches QuickBooks as a character reference (`é`). type: string response_json: description: QuBe Sync's summary of the answer, once the request is completed nullable: true type: object response_xml: description: >- The qbXML response from QuickBooks. One answer can be at most 4 MB as the Web Connector sends it, about 3 MB of qbXML; QuickBooks' answer over that isn't kept: this is null and `error.error_type` is `response_too_large`. nullable: true type: string state: description: >- `waiting`/`retryable`/`ticketed`/`sent` while the Web Connector is on its way; `response_received` once QuickBooks answered successfully (read `response_json.data`, and `response_json.warning` when QuickBooks warned about something it did); `error` when it did not -- the Web Connector could not reach QuickBooks, the qbXML was rejected, or QuickBooks answered with a business error such as 3100 (then `error.error_type` is `quickbooks_business_error` and `response_json` still carries QuickBooks' own `{status: "error", error: {code, type, message}}`); `timed_out` when no answer came back (QuickBooks may still have applied it, so look before sending it again) and `discarded` when your app discarded it before the Web Connector picked it up. Both carry an `error`. enum: - waiting - retryable - ticketed - sent - response_received - error - timed_out - discarded type: string webhook_attempts: items: type: object type: array webhook_error: nullable: true type: string webhook_state: enum: - not_applicable - pending - succeeded - failed type: string webhook_url: format: uri nullable: true type: string required: - id - state - request_xml - links type: object listEntities_response_json: description: >- QuBe Sync's summary of QuickBooks' answer. Only an `Error` severity from QuickBooks is `status: "error"` (and makes the request's `state` `error`), so a query that matched nothing is still `success`. A `Warn` severity is a `success` with `warning` beside it. oneOf: - properties: data: items: oneOf: - properties: ship_address: description: >- This aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only). Do not mix block mode with other address fields. In block mode, each Addr line prints as its own line and is returned in `ship_address_block` or `bill_address_block`. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object mobile: description: Mobile telephone number. type: string bill_address: description: >- This aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only). Do not mix block mode with other address fields. In block mode, each Addr line prints as its own line and is returned in `ship_address_block` or `bill_address_block`. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object job_projected_end_date: description: >- The date on which work for a sub-customer is expected to be complete; used in reports. The Job- elements (`job_desc`, `job_end_date`, `job_projected_end_date`, `job_start_date`, and `job_status`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. format: date type: string delivery_method: enum: - Email - Fax - Print type: string fax: description: Fax number. type: string company_name: description: >- The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.) type: string ship_address_block: description: >- The address expressed as an address block of Addr1 through Addr5, depending on the number of lines in the original request that created the address. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string type: object full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string ship_to_address: items: properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string default_ship_to: description: >- Flag that address is the default ship to address. type: boolean name: description: >- Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct. type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object type: array type: const: customer description: >- Which record type this is; the query answers with several. preferred_payment_method_ref: description: >- Refers to a PaymentMethod object. In a request, if a `preferred_payment_method_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object time_modified: description: Time the object was last modified. format: date-time type: string contact: description: The name of a contact person for a customer or vendor. type: string alt_contact: description: >- The name of an alternate contact person for a vendor, customer, or “other name” entry. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string price_level_ref: description: >- Price levels let you apply custom pricing rules for selected customers. Once assigned, QuickBooks uses those prices automatically on supported sales forms unless explicitly overridden. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object job_status: description: >- `job_status` Status information about a sub-customer; used in reports. The Job- elements (`job_desc`, `job_end_date`, `job_projected_end_date`, `job_start_date`, and `job_status`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. enum: - Awarded - Closed - InProgress - None - NotAwarded - Pending type: string customer_type_ref: description: >- Customer types allow business owners to categorize customers in ways that are meaningful for their businesses. For example, a customer type might indicate which industry a customer represents, or which part of the country a customer is in. A `customer_type_ref` aggregate refers to one of the types on the CustomerType list. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object job_start_date: description: >- The date on which work for a sub-customer was started; used in reports. The Job- elements (`job_desc`, `job_end_date`, `job_projected_end_date`, `job_start_date`, and `job_status`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. format: date type: string credit_limit: description: >- Set and returned as a positive number that indicates a customer’s or vendor’s credit limit. If no value has been defined, there is no credit limit. type: number bill_address_block: description: >- The address expressed as an address block of Addr1 through Addr5, depending on the number of lines in the original request that created the address. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string type: object additional_notes_ret: items: properties: date: description: The date the note was updated. format: date type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string note_id: description: The ID of the note. type: integer type: object type: array job_title: description: >- The job title of a customer, vendor, employee, or person on the “other names” list. type: string name: description: >- Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct. type: string terms_ref: description: >- Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) If a `terms_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object email: description: E-mail address. type: string credit_card_info: description: Customer’s credit-card information. properties: credit_card_address: description: The address associated with this credit card. type: string credit_card_number: description: >- Credit-card number for this customer or this payment. Beginning with qbXML spec 6.0 and QuickBooks 2007, you must mask the credit card number with lower case “x” and no dashes. For example, xxxxxxxxxxxx1234. type: string credit_card_postal_code: description: >- The postal code associated with the address for this credit card. type: string expiration_month: description: The month when the credit card expires. maximum: 12 minimum: 1 type: integer expiration_year: description: The year when the credit card expires. type: integer name_on_card: description: The name on the customer’s credit card. type: string type: object contacts_ret: items: properties: additional_contact_ref: items: properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string type: object type: array contact: description: >- The name of a contact person for a customer or vendor. type: string edit_sequence: description: >- `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes. type: string first_name: description: >- The first name of a customer, vendor, employee, or person on the “other names” list. type: string job_title: description: >- The job title of a customer, vendor, employee, or person on the “other names” list. type: string last_name: description: >- The last name of a customer, vendor, employee, or person on the “other names” list. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string middle_name: description: >- The middle name of a customer, vendor, employee, or person on the “other names” list. type: string salutation: description: >- A formal reference, such as Mr. or Dr., that precedes a name. type: string time_created: description: Time the object was created. format: date-time type: string time_modified: description: Time the object was last modified. format: date-time type: string type: object type: array time_created: description: Time the object was created. format: date-time type: string salutation: description: >- A formal reference, such as Mr. or Dr., that precedes a name. type: string edit_sequence: description: >- `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes. type: string is_statement_with_parent: type: boolean sales_rep_ref: description: >- A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A `sales_rep_ref` refers to a person on the SalesRep list. In a request, if a `sales_rep_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object phone: description: The telephone number. type: string job_desc: description: >- A short job description for a sub-customer; used in reports. The Job- elements (`job_desc`, `job_end_date`, `job_projected_end_date`, `job_start_date`, and `job_status`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. type: string sublevel: description: >- The number of ancestors. For example, The customer job with Name = carpets and `full_name` = Jones:Building2:carpets would have a sublevel of 2. type: integer job_type_ref: description: >- Job type can be used to separate jobs into any categories that are meaningful to the business. A `job_type_ref` aggregate refers to a job type on the JobType list. In a request, if a `job_type_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object class_ref: description: >- Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object data_ext_ret: items: properties: data_ext_name: description: >- The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields. type: string data_ext_type: description: >- The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, `data_ext_type` must be detSTR255TYPE. enum: - AMTTYPE - DATETIMETYPE - INTTYPE - PERCENTTYPE - PRICETYPE - QUANTYPE - STR1024TYPE - STR255TYPE type: string data_ext_value: description: >- The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB. type: string owner_id: description: >- `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension. type: string type: object type: array external_guid: description: >- Allows for the attachment of a user defined GUID value. type: string balance: description: >- A positive number indicates money owed by the customer. Compare with `total_balance`. type: number alt_phone: description: A telephone number given as an alternative to Phone. type: string print_as: description: >- By default within QuickBooks, the `print_as` element is the same as the Name element. type: string total_balance: description: >- Total balance for this customer, including all this customer’s jobs (subcustomers). A positive number indicates money that the customer owes. If a customer doesn’t have any subcustomers, `total_balance` and Balance are the same. type: number middle_name: description: >- The middle name of a customer, vendor, employee, or person on the “other names” list. type: string last_name: description: >- The last name of a customer, vendor, employee, or person on the “other names” list. type: string cc: description: Email address that would be carbon copied or CC. type: string suffix: type: string currency_ref: description: >- A currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object sales_tax_country: description: The country that sales tax is collected for. enum: - Australia - Canada - UK - US type: string item_sales_tax_ref: description: >- An ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead. If both `full_name` and `list_id` are provided for `item_sales_tax_ref`, `list_id` is used. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object additional_contact_ref: items: properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string type: object type: array parent_ref: description: >- A reference to the list object that is one level above this one. For example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request, if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object job_end_date: description: >- The date on which work for a sub-customer was completed; used in reports. The Job- elements (`job_desc`, `job_end_date`, `job_projected_end_date`, `job_start_date`, and `job_status`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. format: date type: string is_active: description: >- If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. type: boolean pager: description: The pager number. type: string sales_tax_code_ref: description: >- `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object tax_registration_number: description: The tax registration number used in CA and UK. type: string first_name: description: >- The first name of a customer, vendor, employee, or person on the “other names” list. type: string resale_number: description: >- The customer’s resale number, if they have one. This number won’t affect reports or sales tax calculations. type: string notes: description: Not supported. type: string account_number: description: >- Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers won’t be visible in the user interface. type: string preferred_delivery_method: description: Preference for how invoices are delivered. enum: - Email - Fax - None type: string required: - type title: CustomerRet type: object - properties: department: description: >- The name of the department in the employment job details section. type: string mobile: description: Mobile telephone number. type: string work_auth_expire_date: description: Date the employee’s work authorization expires. format: date type: string employee_type: description: >- `employee_type` can affect payroll taxes for an employee. A statutory employee is a person who is defined as an employee by statute. Usually an owner or partner will be on the Other Names list, but if they are on the Employee list, their `employee_type` will be Owner. enum: - Officer - Owner - Regular - Statutory type: string disabled: description: Is employee disabled? enum: - 'No' - 'Yes' type: string ssn: description: >- Social security number. When you add an SSN value to an employee record, it doesn’t have to include dashes; for example, either 123-45-6789 or 123456789 would be valid. type: string fax: description: Fax number. type: string hired_date: description: An employee’s date of hire. format: date type: string type: const: employee description: >- Which record type this is; the query answers with several. time_modified: description: Time the object was last modified. format: date-time type: string employee_payroll_info: description: Pay information for this employee. not: anyOf: - required: - clear_earnings - earnings properties: class_ref: description: >- Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object clear_earnings: description: >- If `clear_earnings` is set to true, the earnings will be deleted for this employee. Choose at most one of: `clear_earnings`, or `earnings`. type: boolean earnings: description: >- Choose at most one of: `clear_earnings`, or `earnings`. items: not: anyOf: - required: - rate - rate_percent properties: payroll_item_wage_ref: description: >- Each payroll wage item describes and names a payment scheme, for example, Regular Pay or Overtime Pay. A `payroll_item_wage_ref` aggregate refers to one of these wage items. In a request, if a `payroll_item_wage_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object rate: description: >- Indicates the price of something. Choose at most one of: `rate`, or `rate_percent`. type: number rate_percent: description: >- Indicates the price of something as a percent. Choose at most one of: `rate`, or `rate_percent`. type: number type: object type: array pay_period: description: >- Indicates how often employees are paid. If you include a blank `pay_period` element in an EmployeeMod message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. enum: - Biweekly - Daily - Monthly - Quarterly - Semimonthly - Weekly - Yearly type: string sick_hours: description: >- Describes how “sick time” is accrued for this employee, along with how many sick hours the employee has accrued. properties: accrual_period: description: >- Indicates how an employee accrues time off. If you include a blank `accrual_period` element in an EmployeeMod message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. enum: - BeginningOfYear - EveryHourOnPaycheck - EveryPaycheck type: string accrual_start_date: description: >- When used in the `sick_hours` or `vacation_hours` aggregates, refers to the date on which sick leave or vacation hours in the current year began to accrue. format: date type: string hours_accrued: description: >- The number of hours that the employee will accrue per accrual period. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. type: string hours_available: description: >- The total number of hours currently available for the employee to use. If this value is empty, it will default to 0. type: string hours_used: description: >- When used in the `sick_hours` or `vacation_hours` aggregates, refers to the number of sick leave or vacation hours used in the current year. type: string is_resetting_hours_each_new_year: description: >- Indicates whether or not the hours accrued resets to zero at the beginning of the new year. If you include a blank `is_resetting_hours_each_new_year` element in an EmployeeMod message, you’ll receive an error. type: boolean maximum_hours: description: >- The maximum number of hours that the employee can accrue. (QuickBooks itself doesn’t enforce this limit, however. `hours_available` can be greater than `maximum_hours`.) The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. type: string type: object use_time_data_to_create_paychecks: description: >- Indicates whether time data is used to create paychecks for this employee. enum: - DoNotUseTimeData - NotSet - UseTimeData type: string vacation_hours: description: >- Describes how vacation time is accrued for this employee, along with how many vacation hours the employee has accrued. properties: accrual_period: description: >- Indicates how an employee accrues time off. If you include a blank `accrual_period` element in an EmployeeMod message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. enum: - BeginningOfYear - EveryHourOnPaycheck - EveryPaycheck type: string accrual_start_date: description: >- When used in the `sick_hours` or `vacation_hours` aggregates, refers to the date on which sick leave or vacation hours in the current year began to accrue. format: date type: string hours_accrued: description: >- The number of hours that the employee will accrue per accrual period. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. type: string hours_available: description: >- The total number of hours currently available for the employee to use. If this value is empty, it will default to 0. type: string hours_used: description: >- When used in the `sick_hours` or `vacation_hours` aggregates, refers to the number of sick leave or vacation hours used in the current year. type: string is_resetting_hours_each_new_year: description: >- Indicates whether or not the hours accrued resets to zero at the beginning of the new year. If you include a blank `is_resetting_hours_each_new_year` element in an EmployeeMod message, you’ll receive an error. type: boolean maximum_hours: description: >- The maximum number of hours that the employee can accrue. (QuickBooks itself doesn’t enforce this limit, however. `hours_available` can be greater than `maximum_hours`.) The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. type: string type: object type: object part_or_full_time: description: Full or Part time status of the employee. enum: - FullTime - PartTime type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string us_citizen: description: Is employee a US citizen? enum: - 'No' - 'Yes' type: string us_veteran: description: Is employee a US veteran? enum: - 'No' - 'Yes' type: string gender: description: The gender of this employee. enum: - Female - Male type: string billing_rate_ref: description: >- Billing rates are used to override the service item rate in a time transaction (TimeTrackingAdd) based on the employee or vendor performing the work. Billing rates are assigned to an employee or a vendor to specify overrides to service items. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object additional_notes_ret: items: properties: date: description: The date the note was updated. format: date type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string note_id: description: The ID of the note. type: integer type: object type: array description: description: >- The description details in the employment job details section. type: string job_title: description: >- The job title of a customer, vendor, employee, or person on the “other names” list. type: string name: description: >- Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct. type: string email: description: E-mail address. type: string supervisor_ref: description: >- The name of a customer, vendor, employee, or person on the “other names” list in the employment job details section. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object pager_pin: description: >- A personal identification number for this employee’s pager. type: string time_created: description: Time the object was created. format: date-time type: string salutation: description: >- A formal reference, such as Mr. or Dr., that precedes a name. type: string edit_sequence: description: >- `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes. type: string military_status: description: Military status if the employee is a US veteran. enum: - Active - Reserve type: string phone: description: The telephone number. type: string key_employee: description: Is employee a key or critical employee. enum: - 'No' - 'Yes' type: string data_ext_ret: items: properties: data_ext_name: description: >- The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields. type: string data_ext_type: description: >- The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, `data_ext_type` must be detSTR255TYPE. enum: - AMTTYPE - DATETIMETYPE - INTTYPE - PERCENTTYPE - PRICETYPE - QUANTYPE - STR1024TYPE - STR255TYPE type: string data_ext_value: description: >- The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB. type: string owner_id: description: >- `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension. type: string type: object type: array external_guid: description: >- Allows for the attachment of a user defined GUID value. type: string employee_address: description: >- If an address request fails, some combination of address fields might be too long. If you use payroll, you must specify the employee’s city, state (or province), ZIP (or postal) code, and at least one line of the street address. (Note that the State element has restrictions when it’s used in the `employee_address` aggregate. For more information, click State in the table.) properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object ethnicity: description: Is employee a US citizen? enum: - AmericianIndian - Asian - Black - Hawaiian - Hispanic - TwoOrMoreRaces - White type: string alt_phone: description: A telephone number given as an alternative to Phone. type: string print_as: description: >- By default within QuickBooks, the `print_as` element is the same as the Name element. type: string emergency_contacts: description: Emergency Contact information for the employee. properties: primary_contact: description: >- Primary emergency contact information for the employee. properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string relation: description: >- Relationship of emergency contact information to the employee. enum: - Brother - Daughter - Father - Friend - Mother - Other - Partner - Sister - Son - Spouse type: string type: object secondary_contact: description: >- Secondary emergency contact information for the employee. properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string relation: description: >- Relationship of emergency contact information to the employee. enum: - Brother - Daughter - Father - Friend - Mother - Other - Partner - Sister - Son - Spouse type: string type: object type: object middle_name: description: >- The middle name of a customer, vendor, employee, or person on the “other names” list. type: string last_name: description: >- The last name of a customer, vendor, employee, or person on the “other names” list. type: string birth_date: description: Date of birth. format: date type: string released_date: description: >- The date on which this person’s employment with the company ended. format: date type: string suffix: type: string additional_contact_ref: items: properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string type: object type: array adjusted_service_date: description: Adjusted service date for the employee. format: date type: string is_active: description: >- If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. type: boolean pager: description: The pager number. type: string target_bonus: description: >- The target bonus amount in the employment job details section. type: number exempt: description: Exempt or Non-exempt status of the employee. enum: - Exempt - NonExempt type: string disability_desc: description: Description of employee’s disablitily. type: string original_hire_date: description: Original hire date the employee was hired. format: date type: string first_name: description: >- The first name of a customer, vendor, employee, or person on the “other names” list. type: string on_file: description: Is the employee’s I-9 on file? enum: - 'No' - 'Yes' type: string notes: description: Not supported. type: string account_number: description: >- Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers won’t be visible in the user interface. type: string required: - type title: EmployeeRet type: object - properties: account_number: description: >- Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers won’t be visible in the user interface. type: string alt_contact: description: >- The name of an alternate contact person for a vendor, customer, or “other name” entry. type: string alt_phone: description: A telephone number given as an alternative to Phone. type: string company_name: description: >- The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.) type: string contact: description: The name of a contact person for a customer or vendor. type: string data_ext_ret: items: properties: data_ext_name: description: >- The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields. type: string data_ext_type: description: >- The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, `data_ext_type` must be detSTR255TYPE. enum: - AMTTYPE - DATETIMETYPE - INTTYPE - PERCENTTYPE - PRICETYPE - QUANTYPE - STR1024TYPE - STR255TYPE type: string data_ext_value: description: >- The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB. type: string owner_id: description: >- `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension. type: string type: object type: array edit_sequence: description: >- `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes. type: string email: description: E-mail address. type: string external_guid: description: >- Allows for the attachment of a user defined GUID value. type: string fax: description: Fax number. type: string first_name: description: >- The first name of a customer, vendor, employee, or person on the “other names” list. type: string is_active: description: >- If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. type: boolean last_name: description: >- The last name of a customer, vendor, employee, or person on the “other names” list. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string middle_name: description: >- The middle name of a customer, vendor, employee, or person on the “other names” list. type: string name: description: >- Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct. type: string notes: description: Not supported. type: string other_name_address: description: >- If an address request fails, some combination of address fields might be too long. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object other_name_address_block: description: >- The address expressed as an address block of Addr1 through Addr5, depending on the number of lines in the original request that created the address. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string type: object phone: description: The telephone number. type: string salutation: description: >- A formal reference, such as Mr. or Dr., that precedes a name. type: string time_created: description: Time the object was created. format: date-time type: string time_modified: description: Time the object was last modified. format: date-time type: string type: const: other_name description: >- Which record type this is; the query answers with several. required: - type title: OtherNameRet type: object - properties: vendor_address_block: description: >- The address expressed as an address block of Addr1 through Addr5, depending on the number of lines in the original request that created the address. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string type: object ship_address: description: >- This aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only). Do not mix block mode with other address fields. In block mode, each Addr line prints as its own line and is returned in `ship_address_block` or `bill_address_block`. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object mobile: description: Mobile telephone number. type: string tax_on_sales_account_ref: description: Account used for taxes on sales in CA or UK. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object prefill_account_ref: items: properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object type: array is_sales_tax_agency: description: Indicates whether the entity is a sales tax agency. type: boolean is_tax_agency: description: Is the current entity a tax agency. type: boolean is_tax_on_tax: description: >- For vendor in CA or UK, is there tax charged on top of tax. type: boolean fax: description: Fax number. type: string company_name: description: >- The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.) type: string vendor_type_ref: description: >- Vendor types allow business owners to categorize vendors in ways that are meaningful for their businesses. For example, a vendor type might indicate which industry a vendor represents, or which part of the country a vendor is in. A `vendor_type_ref` aggregate refers to one of the types on the VendorType list. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object is_tax_tracked_on_sales: description: >- This flag is used for CA or UK and whether tax is tracked on sales. type: boolean type: const: vendor description: >- Which record type this is; the query answers with several. time_modified: description: Time the object was last modified. format: date-time type: string contact: description: The name of a contact person for a customer or vendor. type: string vendor_address: description: >- If an address request fails, some combination of address fields might be too long. properties: addr1: description: The first line of an address. type: string addr2: description: >- The second line of an address (if a second line is needed). type: string addr3: description: >- The third line of an address (if a third line is needed). type: string addr4: description: >- The fourth line of an address (if a fourth line is needed). type: string addr5: description: >- The fifth line of an address (if a fifth line is needed). type: string city: description: The city name in an address. type: string country: description: >- The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string postal_code: description: The postal code in an address. type: string state: description: The state name in an address. type: string type: object reporting_period: description: >- Vendor reporting period for CA or UK. This can be monthly or quarterly. enum: - Monthly - Quarterly type: string alt_contact: description: >- The name of an alternate contact person for a vendor, customer, or “other name” entry. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string billing_rate_ref: description: >- Billing rates are used to override the service item rate in a time transaction (TimeTrackingAdd) based on the employee or vendor performing the work. Billing rates are assigned to an employee or a vendor to specify overrides to service items. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object credit_limit: description: >- Set and returned as a positive number that indicates a customer’s or vendor’s credit limit. If no value has been defined, there is no credit limit. type: number additional_notes_ret: items: properties: date: description: The date the note was updated. format: date type: string note: description: >- In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form. type: string note_id: description: The ID of the note. type: integer type: object type: array job_title: description: >- The job title of a customer, vendor, employee, or person on the “other names” list. type: string name: description: >- Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct. type: string terms_ref: description: >- Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) If a `terms_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object email: description: E-mail address. type: string tax_on_purchases_account_ref: description: Account used for taxes on purchases in CA or UK. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object is_vendor_eligible_for1099: description: >- If `is_vendor_eligible_for1099` is set to true, `vendor_tax_ident` and `vendor_address` are required in a vendor add request message. Otherwise, `vendor_tax_ident` and `vendor_address` are optional. type: boolean sales_tax_return_ref: description: Sales tax return information. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object contacts_ret: items: properties: additional_contact_ref: items: properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string type: object type: array contact: description: >- The name of a contact person for a customer or vendor. type: string edit_sequence: description: >- `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes. type: string first_name: description: >- The first name of a customer, vendor, employee, or person on the “other names” list. type: string job_title: description: >- The job title of a customer, vendor, employee, or person on the “other names” list. type: string last_name: description: >- The last name of a customer, vendor, employee, or person on the “other names” list. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string middle_name: description: >- The middle name of a customer, vendor, employee, or person on the “other names” list. type: string salutation: description: >- A formal reference, such as Mr. or Dr., that precedes a name. type: string time_created: description: Time the object was created. format: date-time type: string time_modified: description: Time the object was last modified. format: date-time type: string type: object type: array time_created: description: Time the object was created. format: date-time type: string salutation: description: >- A formal reference, such as Mr. or Dr., that precedes a name. type: string edit_sequence: description: >- `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes. type: string phone: description: The telephone number. type: string vendor_tax_ident: description: A character string that identifies a vendor. type: string class_ref: description: >- Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object data_ext_ret: items: properties: data_ext_name: description: >- The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields. type: string data_ext_type: description: >- The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, `data_ext_type` must be detSTR255TYPE. enum: - AMTTYPE - DATETIMETYPE - INTTYPE - PERCENTTYPE - PRICETYPE - QUANTYPE - STR1024TYPE - STR255TYPE type: string data_ext_value: description: >- The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB. type: string owner_id: description: >- `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension. type: string type: object type: array external_guid: description: >- Allows for the attachment of a user defined GUID value. type: string balance: description: >- A positive number indicates money owed by the customer. Compare with `total_balance`. type: number name_on_check: description: >- The vendor’s name as it will appear on checks sent to the vendor. (Corresponds in the QuickBooks user interface to the “Print on Check as” field of the Edit Vendor and New Vendor windows.) type: string alt_phone: description: A telephone number given as an alternative to Phone. type: string middle_name: description: >- The middle name of a customer, vendor, employee, or person on the “other names” list. type: string last_name: description: >- The last name of a customer, vendor, employee, or person on the “other names” list. type: string cc: description: Email address that would be carbon copied or CC. type: string suffix: type: string currency_ref: description: >- A currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object sales_tax_country: description: The country that sales tax is collected for. enum: - Australia - Canada - UK - US type: string additional_contact_ref: items: properties: contact_name: description: The name of the contact. type: string contact_value: description: The value of the contact field. type: string type: object type: array is_active: description: >- If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. type: boolean pager: description: The pager number. type: string sales_tax_code_ref: description: >- `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored. properties: full_name: description: >- `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. type: string list_id: description: >- `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list family, not across the company file: customers, vendors, employees and other names share one sequence, every item type shares another, and each other list has its own. type: string type: object is_tax_tracked_on_purchases: description: >- This flag is used for CA or UK and whether tax is tracked on purchases. type: boolean tax_registration_number: description: The tax registration number used in CA and UK. type: string first_name: description: >- The first name of a customer, vendor, employee, or person on the “other names” list. type: string notes: description: Not supported. type: string account_number: description: >- Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers won’t be visible in the user interface. type: string required: - type title: VendorRet type: object type: array message: description: >- QuickBooks' own status message, carried through when there is no data to show for an otherwise successful request (a query that matched nothing, say). * `no_match` (1): The query ran and matched nothing. * `not_found_by_key` (500): A record was looked up by an exact key (a FullName or ListID) and does not exist. What each means and how to handle it: [Error handling](https://docs.qubesync.com/error_handling#quickbooks-said-no). type: string status: const: success warning: description: >- Present only when QuickBooks answered with a `Warn` severity: it carried the request out, and `data` is what it saved or found, but it has something to say about it. For example code `530` with the message `The field "Memo" is not supported by this implementation.` means the record was saved without that field, so an add or update that comes back with a `warning` may not have saved everything it sent. Absent on a plain success and on an error. properties: code: description: >- QuickBooks' own statusCode. The stable thing to branch on. * `not_found_by_key` (500): A record was looked up by an exact key (a FullName or ListID) and does not exist. What each means and how to handle it: [Error handling](https://docs.qubesync.com/error_handling#quickbooks-said-yes-with-a-warning). examples: - 500 type: integer message: description: >- QuickBooks' own statusMessage, such as which field it did not support. type: string required: - code type: object required: - status title: Success type: object - properties: error: properties: code: description: QuickBooks' own statusCode. The stable thing to branch on. examples: - 1030 - 3150 - 3210 - 3220 - 3250 - 3260 type: - integer - 'null' message: description: QuickBooks' own statusMessage. type: string type: description: >- A stable name for `code`, when QuBeSync recognises it. Absent otherwise: coverage widens over time, so treat this as a hint and branch on `code` if you need certainty. * `unsupported_request` (1030): The QuickBooks this connection talks to does not support this request. * `missing_element` (3150): QuickBooks requires an element the request left out; the message names it. * `invalid_value` (3210): A field's value is not one QuickBooks accepts; the message names the field and the value. * `not_authorized` (3220): QuickBooks refused the request: no permission for it, or the feature is turned off in this company file. * `feature_not_enabled` (3250): The feature is turned off in this company file, or this edition of QuickBooks does not have it. * `insufficient_permission` (3260): The permission level QuickBooks granted does not allow this action. What each means and how to handle it: [Error handling](https://docs.qubesync.com/error_handling#quickbooks-said-no). enum: - unsupported_request - missing_element - invalid_value - not_authorized - feature_not_enabled - insufficient_permission type: string type: object status: const: error required: - status - error title: Error type: object Error: description: >- What a refused request answers with. The one key is errors, and its shape says what went wrong: a sentence when the endpoint explains the refusal in words (a parameter the operation does not take, a key already taken, a run that has already ended); an object with detail, and a code when there is one, when the request named nothing that exists or may not do what it asked (402, 403, 404, and a CLI session's 401), or an answer to a run's question was refused (the decisions endpoint's 400, 409 and 422, which always carry a code to branch on); an object of fields, each a list of messages, when a record failed validation and nothing was saved; a list of {path, message} problems when a submitted document or input fails validation. A request without a usable API key gets a 401 Basic challenge with the plain-text body Unauthorized, not JSON. properties: errors: oneOf: - example: 'unknown parameter: "emial"' title: A sentence type: string - properties: code: example: read_only_session type: string detail: example: Not Found type: string required: - detail title: Detail and code type: object - additionalProperties: items: type: string type: array example: webhook_url: - may not contain a username or password title: Field by field type: object - items: properties: message: example: is required type: string path: example: input.customer type: string required: - path - message type: object title: Located problems type: array required: - errors type: object headers: IdempotentReplayed: description: >- `true` when the call repeated an earlier call's `Idempotency-Key`: this is what that call created, as it is now, and nothing new was queued. Absent otherwise. schema: enum: - 'true' type: string responses: BadRequest: content: application/json: example: errors: 'unknown parameter: "emial"' schema: $ref: '#/components/schemas/Error' description: >- A parameter the operation does not take, or a value it cannot use. Nothing was queued. Unauthorized: content: text/plain: example: Unauthorized schema: type: string description: >- No usable API key. The key is Basic auth, so the answer is the challenge, with the plain-text body Unauthorized rather than JSON. headers: WWW-Authenticate: schema: example: Basic realm="Application" type: string SandboxPaused: content: application/json: example: errors: detail: >- Sandbox access is paused for this organization because the sandbox period expired and the organization does not currently have both active billing and a recent production connection. Please request an extension if you're still working on your integration or contact support if you have questions. schema: $ref: '#/components/schemas/Error' description: >- A sandbox app whose organization's sandbox access is paused. Nothing was queued. NotFound: content: application/json: example: errors: detail: Not Found schema: $ref: '#/components/schemas/Error' description: Nothing by that id, or it belongs to another app. UnprocessableEntity: content: application/json: example: errors: webhook_url: - may not contain a username or password schema: $ref: '#/components/schemas/Error' description: >- A field failed validation, field by field, and nothing was queued: a `webhook_url` that is not an absolute http or https URL, carries a username or password, is longer than 2048 characters, or (in production) points at localhost or a private address. An `Idempotency-Key` that isn't 1 to 255 printable ASCII characters, or that was already used for a different request, is refused in a sentence naming the header. securitySchemes: apiKey: description: Use your app's API key as the username, and leave the password blank scheme: basic type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.