Update vendor

curl --request PUT \
  --url https://qubesync.com/api/v2/connections/{connection_id}/vendors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "Northwind Supplies",
  "edit_sequence": "1700000000",
  "email": "[email protected]",
  "list_id": "80000001-1700000000",
  "name": "Northwind Supplies",
  "phone": "555-0100"
}
'

import requests

url = "https://qubesync.com/api/v2/connections/{connection_id}/vendors"

payload = {
    "company_name": "Northwind Supplies",
    "edit_sequence": "1700000000",
    "email": "[email protected]",
    "list_id": "80000001-1700000000",
    "name": "Northwind Supplies",
    "phone": "555-0100"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_name: 'Northwind Supplies',
    edit_sequence: '1700000000',
    email: '[email protected]',
    list_id: '80000001-1700000000',
    name: 'Northwind Supplies',
    phone: '555-0100'
  })
};

fetch('https://qubesync.com/api/v2/connections/{connection_id}/vendors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qubesync.com/api/v2/connections/{connection_id}/vendors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'company_name' => 'Northwind Supplies',
    'edit_sequence' => '1700000000',
    'email' => '[email protected]',
    'list_id' => '80000001-1700000000',
    'name' => 'Northwind Supplies',
    'phone' => '555-0100'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qubesync.com/api/v2/connections/{connection_id}/vendors"

	payload := strings.NewReader("{\n  \"company_name\": \"Northwind Supplies\",\n  \"edit_sequence\": \"1700000000\",\n  \"email\": \"[email protected]\",\n  \"list_id\": \"80000001-1700000000\",\n  \"name\": \"Northwind Supplies\",\n  \"phone\": \"555-0100\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://qubesync.com/api/v2/connections/{connection_id}/vendors")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_name\": \"Northwind Supplies\",\n  \"edit_sequence\": \"1700000000\",\n  \"email\": \"[email protected]\",\n  \"list_id\": \"80000001-1700000000\",\n  \"name\": \"Northwind Supplies\",\n  \"phone\": \"555-0100\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qubesync.com/api/v2/connections/{connection_id}/vendors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_name\": \"Northwind Supplies\",\n  \"edit_sequence\": \"1700000000\",\n  \"email\": \"[email protected]\",\n  \"list_id\": \"80000001-1700000000\",\n  \"name\": \"Northwind Supplies\",\n  \"phone\": \"555-0100\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "links": {
      "connection_ui": "<string>",
      "pages": "<string>",
      "self": "<string>",
      "ui": "<string>"
    },
    "request_xml": "<string>",
    "state": "waiting",
    "error": {
      "debug_message": "<string>",
      "error_code": 123,
      "error_type": "xml_error",
      "hresult": "<string>",
      "message": "<string>",
      "user_message": "<string>"
    },
    "inserted_at": "2023-11-07T05:31:56Z",
    "iteration_state": "not_applicable",
    "original_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "page": 123,
    "request_types": [
      "<string>"
    ],
    "response_json": {
      "status": "success",
      "data": {
        "vendor_address_block": {
          "addr1": "<string>",
          "addr2": "<string>",
          "addr3": "<string>",
          "addr4": "<string>",
          "addr5": "<string>"
        },
        "ship_address": {
          "addr1": "<string>",
          "addr2": "<string>",
          "addr3": "<string>",
          "addr4": "<string>",
          "addr5": "<string>",
          "city": "<string>",
          "country": "<string>",
          "note": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "mobile": "<string>",
        "tax_on_sales_account_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "prefill_account_ref": [
          {
            "full_name": "<string>",
            "list_id": "<string>"
          }
        ],
        "is_sales_tax_agency": true,
        "is_tax_agency": true,
        "is_tax_on_tax": true,
        "fax": "<string>",
        "company_name": "<string>",
        "vendor_type_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "is_tax_tracked_on_sales": true,
        "time_modified": "2023-11-07T05:31:56Z",
        "contact": "<string>",
        "vendor_address": {
          "addr1": "<string>",
          "addr2": "<string>",
          "addr3": "<string>",
          "addr4": "<string>",
          "addr5": "<string>",
          "city": "<string>",
          "country": "<string>",
          "note": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "reporting_period": "Monthly",
        "alt_contact": "<string>",
        "list_id": "<string>",
        "billing_rate_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "credit_limit": 123,
        "additional_notes_ret": [
          {
            "date": "2023-12-25",
            "note": "<string>",
            "note_id": 123
          }
        ],
        "job_title": "<string>",
        "name": "<string>",
        "terms_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "email": "<string>",
        "tax_on_purchases_account_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "is_vendor_eligible_for1099": true,
        "sales_tax_return_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "contacts_ret": [
          {
            "additional_contact_ref": [
              {
                "contact_name": "<string>",
                "contact_value": "<string>"
              }
            ],
            "contact": "<string>",
            "edit_sequence": "<string>",
            "first_name": "<string>",
            "job_title": "<string>",
            "last_name": "<string>",
            "list_id": "<string>",
            "middle_name": "<string>",
            "salutation": "<string>",
            "time_created": "2023-11-07T05:31:56Z",
            "time_modified": "2023-11-07T05:31:56Z"
          }
        ],
        "time_created": "2023-11-07T05:31:56Z",
        "salutation": "<string>",
        "edit_sequence": "<string>",
        "phone": "<string>",
        "vendor_tax_ident": "<string>",
        "class_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "data_ext_ret": [
          {
            "data_ext_name": "<string>",
            "data_ext_type": "AMTTYPE",
            "data_ext_value": "<string>",
            "owner_id": "<string>"
          }
        ],
        "external_guid": "<string>",
        "balance": 123,
        "name_on_check": "<string>",
        "alt_phone": "<string>",
        "middle_name": "<string>",
        "last_name": "<string>",
        "cc": "<string>",
        "suffix": "<string>",
        "currency_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "sales_tax_country": "Australia",
        "additional_contact_ref": [
          {
            "contact_name": "<string>",
            "contact_value": "<string>"
          }
        ],
        "is_active": true,
        "pager": "<string>",
        "sales_tax_code_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "is_tax_tracked_on_purchases": true,
        "tax_registration_number": "<string>",
        "first_name": "<string>",
        "notes": "<string>",
        "account_number": "<string>"
      },
      "message": "<string>",
      "warning": {
        "code": 123,
        "message": "<string>"
      }
    },
    "response_xml": "<string>",
    "webhook_attempts": [
      {}
    ],
    "webhook_error": "<string>",
    "webhook_state": "not_applicable",
    "webhook_url": "<string>"
  }
}

{
  "errors": "unknown parameter: \"emial\""
}

Unauthorized

{
  "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."
  }
}

{
  "errors": {
    "detail": "Not Found"
  }
}

{
  "errors": {
    "webhook_url": [
      "may not contain a username or password"
    ]
  }
}

PUT

connections

{connection_id}

vendors

Update vendor

curl --request PUT \
  --url https://qubesync.com/api/v2/connections/{connection_id}/vendors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "Northwind Supplies",
  "edit_sequence": "1700000000",
  "email": "[email protected]",
  "list_id": "80000001-1700000000",
  "name": "Northwind Supplies",
  "phone": "555-0100"
}
'

import requests

url = "https://qubesync.com/api/v2/connections/{connection_id}/vendors"

payload = {
    "company_name": "Northwind Supplies",
    "edit_sequence": "1700000000",
    "email": "[email protected]",
    "list_id": "80000001-1700000000",
    "name": "Northwind Supplies",
    "phone": "555-0100"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_name: 'Northwind Supplies',
    edit_sequence: '1700000000',
    email: '[email protected]',
    list_id: '80000001-1700000000',
    name: 'Northwind Supplies',
    phone: '555-0100'
  })
};

fetch('https://qubesync.com/api/v2/connections/{connection_id}/vendors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qubesync.com/api/v2/connections/{connection_id}/vendors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'company_name' => 'Northwind Supplies',
    'edit_sequence' => '1700000000',
    'email' => '[email protected]',
    'list_id' => '80000001-1700000000',
    'name' => 'Northwind Supplies',
    'phone' => '555-0100'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qubesync.com/api/v2/connections/{connection_id}/vendors"

	payload := strings.NewReader("{\n  \"company_name\": \"Northwind Supplies\",\n  \"edit_sequence\": \"1700000000\",\n  \"email\": \"[email protected]\",\n  \"list_id\": \"80000001-1700000000\",\n  \"name\": \"Northwind Supplies\",\n  \"phone\": \"555-0100\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://qubesync.com/api/v2/connections/{connection_id}/vendors")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_name\": \"Northwind Supplies\",\n  \"edit_sequence\": \"1700000000\",\n  \"email\": \"[email protected]\",\n  \"list_id\": \"80000001-1700000000\",\n  \"name\": \"Northwind Supplies\",\n  \"phone\": \"555-0100\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qubesync.com/api/v2/connections/{connection_id}/vendors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_name\": \"Northwind Supplies\",\n  \"edit_sequence\": \"1700000000\",\n  \"email\": \"[email protected]\",\n  \"list_id\": \"80000001-1700000000\",\n  \"name\": \"Northwind Supplies\",\n  \"phone\": \"555-0100\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "links": {
      "connection_ui": "<string>",
      "pages": "<string>",
      "self": "<string>",
      "ui": "<string>"
    },
    "request_xml": "<string>",
    "state": "waiting",
    "error": {
      "debug_message": "<string>",
      "error_code": 123,
      "error_type": "xml_error",
      "hresult": "<string>",
      "message": "<string>",
      "user_message": "<string>"
    },
    "inserted_at": "2023-11-07T05:31:56Z",
    "iteration_state": "not_applicable",
    "original_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "page": 123,
    "request_types": [
      "<string>"
    ],
    "response_json": {
      "status": "success",
      "data": {
        "vendor_address_block": {
          "addr1": "<string>",
          "addr2": "<string>",
          "addr3": "<string>",
          "addr4": "<string>",
          "addr5": "<string>"
        },
        "ship_address": {
          "addr1": "<string>",
          "addr2": "<string>",
          "addr3": "<string>",
          "addr4": "<string>",
          "addr5": "<string>",
          "city": "<string>",
          "country": "<string>",
          "note": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "mobile": "<string>",
        "tax_on_sales_account_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "prefill_account_ref": [
          {
            "full_name": "<string>",
            "list_id": "<string>"
          }
        ],
        "is_sales_tax_agency": true,
        "is_tax_agency": true,
        "is_tax_on_tax": true,
        "fax": "<string>",
        "company_name": "<string>",
        "vendor_type_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "is_tax_tracked_on_sales": true,
        "time_modified": "2023-11-07T05:31:56Z",
        "contact": "<string>",
        "vendor_address": {
          "addr1": "<string>",
          "addr2": "<string>",
          "addr3": "<string>",
          "addr4": "<string>",
          "addr5": "<string>",
          "city": "<string>",
          "country": "<string>",
          "note": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "reporting_period": "Monthly",
        "alt_contact": "<string>",
        "list_id": "<string>",
        "billing_rate_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "credit_limit": 123,
        "additional_notes_ret": [
          {
            "date": "2023-12-25",
            "note": "<string>",
            "note_id": 123
          }
        ],
        "job_title": "<string>",
        "name": "<string>",
        "terms_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "email": "<string>",
        "tax_on_purchases_account_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "is_vendor_eligible_for1099": true,
        "sales_tax_return_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "contacts_ret": [
          {
            "additional_contact_ref": [
              {
                "contact_name": "<string>",
                "contact_value": "<string>"
              }
            ],
            "contact": "<string>",
            "edit_sequence": "<string>",
            "first_name": "<string>",
            "job_title": "<string>",
            "last_name": "<string>",
            "list_id": "<string>",
            "middle_name": "<string>",
            "salutation": "<string>",
            "time_created": "2023-11-07T05:31:56Z",
            "time_modified": "2023-11-07T05:31:56Z"
          }
        ],
        "time_created": "2023-11-07T05:31:56Z",
        "salutation": "<string>",
        "edit_sequence": "<string>",
        "phone": "<string>",
        "vendor_tax_ident": "<string>",
        "class_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "data_ext_ret": [
          {
            "data_ext_name": "<string>",
            "data_ext_type": "AMTTYPE",
            "data_ext_value": "<string>",
            "owner_id": "<string>"
          }
        ],
        "external_guid": "<string>",
        "balance": 123,
        "name_on_check": "<string>",
        "alt_phone": "<string>",
        "middle_name": "<string>",
        "last_name": "<string>",
        "cc": "<string>",
        "suffix": "<string>",
        "currency_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "sales_tax_country": "Australia",
        "additional_contact_ref": [
          {
            "contact_name": "<string>",
            "contact_value": "<string>"
          }
        ],
        "is_active": true,
        "pager": "<string>",
        "sales_tax_code_ref": {
          "full_name": "<string>",
          "list_id": "<string>"
        },
        "is_tax_tracked_on_purchases": true,
        "tax_registration_number": "<string>",
        "first_name": "<string>",
        "notes": "<string>",
        "account_number": "<string>"
      },
      "message": "<string>",
      "warning": {
        "code": 123,
        "message": "<string>"
      }
    },
    "response_xml": "<string>",
    "webhook_attempts": [
      {}
    ],
    "webhook_error": "<string>",
    "webhook_state": "not_applicable",
    "webhook_url": "<string>"
  }
}

{
  "errors": "unknown parameter: \"emial\""
}

Unauthorized

{
  "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."
  }
}

{
  "errors": {
    "detail": "Not Found"
  }
}

{
  "errors": {
    "webhook_url": [
      "may not contain a username or password"
    ]
  }
}

Authorizations

Authorization

string

header

required

Use your app's API key as the username, and leave the password blank

Headers

Idempotency-Key

string

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.

Required string length: 1 - 255

Pattern: ^[\x20-\x7E]+$

Path Parameters

connection_id

string<uuid>

required

The connection (a customer's QuickBooks company file) this request is queued for.

Query Parameters

webhook_url

string<uri>

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.

Maximum string length: 2048

Body

application/json

list_id

string

required

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.

edit_sequence

string

required

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.

additional_notes_mod

object[]

Show child attributes

request_id

string

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.

ship_address

object

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 ShipAddressBlock or BillAddressBlock.

Show child attributes

mobile

string

tax_on_sales_account_ref

object

Account used for taxes on sales in CA or UK.

Show child attributes

contacts_mod

object[]

Show child attributes

prefill_account_ref

object[]

Show child attributes

is_sales_tax_agency

boolean

Indicates whether the entity is a sales tax agency.

is_tax_on_tax

boolean

For vendor in CA or UK, is there tax charged on top of tax.

fax

string

Fax number.

company_name

string

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.)

vendor_type_ref

object

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.

Show child attributes

is_tax_tracked_on_sales

boolean

This flag is used for CA or UK and whether tax is tracked on sales.

contact

string

The name of a contact person for a customer or vendor.

vendor_address

object

If an address request fails, some combination of address fields might be too long.

Show child attributes

reporting_period

enum<string>

Vendor reporting period for CA or UK. This can be monthly or quarterly.

Available options:

Monthly,

Quarterly

alt_contact

string

The name of an alternate contact person for a vendor, customer, or “other name” entry.

billing_rate_ref

object

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.

Show child attributes

credit_limit

number

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.

job_title

string

The job title of a customer, vendor, employee, or person on the “other names” list.

name

string

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.

terms_ref

object

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.

Show child attributes

string

E-mail address.

tax_on_purchases_account_ref

object

Account used for taxes on purchases in CA or UK.

Show child attributes

is_vendor_eligible_for1099

boolean

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.

sales_tax_return_ref

object

Sales tax return information.

Show child attributes

salutation

string

A formal reference, such as Mr. or Dr., that precedes a name.

phone

string

The telephone number.

vendor_tax_ident

string

A character string that identifies a vendor.

class_ref

object

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.

Show child attributes

name_on_check

string

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.)

alt_phone

string

A telephone number given as an alternative to Phone.

middle_name

string

The middle name of a customer, vendor, employee, or person on the “other names” list.

last_name

string

The last name of a customer, vendor, employee, or person on the “other names” list.

string

Email address that would be carbon copied or CC.

suffix

string

currency_ref

object

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.

Show child attributes

sales_tax_country

enum<string>

The country that sales tax is collected for.

Available options:

Australia,

Canada,

UK,

US

additional_contact_ref

object[]

Show child attributes

is_active

boolean

If is_active is true, this object is currently enabled for use by QuickBooks. The default value is true.

sales_tax_code_ref

object

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.

Show child attributes

is_tax_tracked_on_purchases

boolean

This flag is used for CA or UK and whether tax is tracked on purchases.

tax_registration_number

string

The tax registration number used in CA and UK.

first_name

string

The first name of a customer, vendor, employee, or person on the “other names” list.

notes

string

Additional information about this vendor.

include_ret_element

enum<string>[]

Available options:

AccountNumber,

AdditionalContactRef,

AdditionalNotesRet,

AltContact,

AltPhone,

Balance,

BillingRateRef,

Cc,

ClassRef,

CompanyName,

Contact,

ContactsRet,

CreditLimit,

CurrencyRef,

DataExtRet,

EditSequence,

Email,

ExternalGUID,

Fax,

FirstName,

IsActive,

IsSalesTaxAgency,

IsTaxAgency,

IsTaxOnTax,

IsTaxTrackedOnPurchases,

IsTaxTrackedOnSales,

IsVendorEligibleFor1099,

JobTitle,

LastName,

ListID,

MiddleName,

Mobile,

Name,

NameOnCheck,

Notes,

OwnerID,

Pager,

Phone,

PrefillAccountRef,

ReportingPeriod,

SalesTaxCodeRef,

SalesTaxCountry,

SalesTaxReturnRef,

Salutation,

ShipAddress,

Suffix,

TaxOnPurchasesAccountRef,

TaxOnSalesAccountRef,

TaxRegistrationNumber,

TermsRef,

TimeCreated,

TimeModified,

TxnID,

TxnNumber,

VendorAddress,

VendorAddressBlock,

VendorTaxIdent,

VendorTypeRef

account_number

string

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.

Callbacks

POST

{$request.query.webhook_url}answered

Body

application/json

POSTed to webhook_url as JSON, signed with X-QUBE-Signature (t=<timestamp>,v1=<hex HMAC-SHA256 of "<timestamp>.<raw body>" with your app's webhook secret>).

app_id

string<uuid>

required

Your app's id.

app_name

string

required

error

object | null

required

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.

Show child attributes

string<uuid>

required

The request's id, as the 201 returned it. For an iterated query, every page carries the first page's id here.

page_request_id

string<uuid>

required

This page's own id. Equal to id except on later pages of an iterated query.

response_json

Success · object

required

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.

Success
Error

Show child attributes

sandbox

boolean

required

Whether the app is a sandbox app.

state

enum<string>

required

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.

Available options:

response_received,

error,

retryable,

timed_out,

discarded

timestamp

integer

required

Unix seconds; the same t the signature covers.

iteration_state

enum<string>

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.

Available options:

not_applicable,

continue,

done,

max_sandbox_iterations_reached

links

object

Present only with response_xml_omitted.

Show child attributes

page

integer | null

The page number, when iterated.

response_xml

string | null

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.

response_xml_omitted

boolean

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.

Response

2XX

Received. Anything else is retried with backoff for about 8 hours.

Response

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.

data

object

required

Show child attributes

Overview

API v2

API v1 (legacy)

Update vendor

Authorizations

Headers

Path Parameters

Query Parameters

Body

Callbacks

Body

Response

Response