Create Customer

curl --request POST \
  --url https://qubesync.com/api/v1/connections/{connection_id}/customers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Co",
  "company_name": "Acme Corporation",
  "first_name": "John",
  "last_name": "Doe",
  "bill_address": {
    "addr1": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701"
  },
  "phone": "512-555-0100",
  "email": "[email protected]",
  "terms_list_id": "80000014-1234567890"
}
'

import requests

url = "https://qubesync.com/api/v1/connections/{connection_id}/customers"

payload = {
    "name": "Acme Co",
    "company_name": "Acme Corporation",
    "first_name": "John",
    "last_name": "Doe",
    "bill_address": {
        "addr1": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "postal_code": "78701"
    },
    "phone": "512-555-0100",
    "email": "[email protected]",
    "terms_list_id": "80000014-1234567890"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Co',
    company_name: 'Acme Corporation',
    first_name: 'John',
    last_name: 'Doe',
    bill_address: {addr1: '123 Main St', city: 'Austin', state: 'TX', postal_code: '78701'},
    phone: '512-555-0100',
    email: '[email protected]',
    terms_list_id: '80000014-1234567890'
  })
};

fetch('https://qubesync.com/api/v1/connections/{connection_id}/customers', 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/v1/connections/{connection_id}/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Acme Co',
    'company_name' => 'Acme Corporation',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'bill_address' => [
        'addr1' => '123 Main St',
        'city' => 'Austin',
        'state' => 'TX',
        'postal_code' => '78701'
    ],
    'phone' => '512-555-0100',
    'email' => '[email protected]',
    'terms_list_id' => '80000014-1234567890'
  ]),
  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/v1/connections/{connection_id}/customers"

	payload := strings.NewReader("{\n  \"name\": \"Acme Co\",\n  \"company_name\": \"Acme Corporation\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"bill_address\": {\n    \"addr1\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"postal_code\": \"78701\"\n  },\n  \"phone\": \"512-555-0100\",\n  \"email\": \"[email protected]\",\n  \"terms_list_id\": \"80000014-1234567890\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://qubesync.com/api/v1/connections/{connection_id}/customers")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Co\",\n  \"company_name\": \"Acme Corporation\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"bill_address\": {\n    \"addr1\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"postal_code\": \"78701\"\n  },\n  \"phone\": \"512-555-0100\",\n  \"email\": \"[email protected]\",\n  \"terms_list_id\": \"80000014-1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Co\",\n  \"company_name\": \"Acme Corporation\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"bill_address\": {\n    \"addr1\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"postal_code\": \"78701\"\n  },\n  \"phone\": \"512-555-0100\",\n  \"email\": \"[email protected]\",\n  \"terms_list_id\": \"80000014-1234567890\"\n}"

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

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "waiting",
    "request_xml": "<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>100</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "page": 1,
    "original_request_id": "550e8400-e29b-41d4-a716-446655440000",
    "iteration_state": "not_applicable",
    "request_types": [
      "CustomerQueryRq"
    ],
    "webhook_state": "not_applicable",
    "request_json": {
      "version": "13.0",
      "request": {
        "name": "CustomerQueryRq",
        "attributes": {
          "requestID": "1"
        },
        "children": [
          {
            "name": "MaxReturned",
            "text": "100"
          }
        ]
      }
    },
    "response_xml": "<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>",
    "response_json": [
      {}
    ],
    "webhook_url": "https://example.com/webhook",
    "webhook_attempts": [
      {
        "status": "succeeded",
        "sent_at": "2023-11-07T05:31:56Z",
        "error": "<string>",
        "attempted_at": "2023-11-07T05:31:56Z",
        "response": "<string>"
      }
    ],
    "webhook_error": "<string>",
    "error": {
      "error_type": "xml_error",
      "message": "<string>",
      "user_message": "<string>",
      "error_code": 123,
      "hresult": "<string>",
      "debug_message": "<string>",
      "code": "<string>",
      "details": {}
    },
    "links": {
      "self": "/api/v1/connections/123e4567-e89b-12d3-a456-426614174000/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "ui": "/app/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "connection_ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000",
      "pages": "/api/v2/connections/123e4567-e89b-12d3-a456-426614174000/queued-requests/550e8400-e29b-41d4-a716-446655440000/pages"
    },
    "inserted_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:01Z"
  }
}

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

Unauthorized

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

{
  "errors": {
    "webhook_url": [
      "must be an http or https URL"
    ]
  }
}

POST

connections

{connection_id}

customers

Create Customer

curl --request POST \
  --url https://qubesync.com/api/v1/connections/{connection_id}/customers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Co",
  "company_name": "Acme Corporation",
  "first_name": "John",
  "last_name": "Doe",
  "bill_address": {
    "addr1": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701"
  },
  "phone": "512-555-0100",
  "email": "[email protected]",
  "terms_list_id": "80000014-1234567890"
}
'

import requests

url = "https://qubesync.com/api/v1/connections/{connection_id}/customers"

payload = {
    "name": "Acme Co",
    "company_name": "Acme Corporation",
    "first_name": "John",
    "last_name": "Doe",
    "bill_address": {
        "addr1": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "postal_code": "78701"
    },
    "phone": "512-555-0100",
    "email": "[email protected]",
    "terms_list_id": "80000014-1234567890"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Co',
    company_name: 'Acme Corporation',
    first_name: 'John',
    last_name: 'Doe',
    bill_address: {addr1: '123 Main St', city: 'Austin', state: 'TX', postal_code: '78701'},
    phone: '512-555-0100',
    email: '[email protected]',
    terms_list_id: '80000014-1234567890'
  })
};

fetch('https://qubesync.com/api/v1/connections/{connection_id}/customers', 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/v1/connections/{connection_id}/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Acme Co',
    'company_name' => 'Acme Corporation',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'bill_address' => [
        'addr1' => '123 Main St',
        'city' => 'Austin',
        'state' => 'TX',
        'postal_code' => '78701'
    ],
    'phone' => '512-555-0100',
    'email' => '[email protected]',
    'terms_list_id' => '80000014-1234567890'
  ]),
  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/v1/connections/{connection_id}/customers"

	payload := strings.NewReader("{\n  \"name\": \"Acme Co\",\n  \"company_name\": \"Acme Corporation\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"bill_address\": {\n    \"addr1\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"postal_code\": \"78701\"\n  },\n  \"phone\": \"512-555-0100\",\n  \"email\": \"[email protected]\",\n  \"terms_list_id\": \"80000014-1234567890\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://qubesync.com/api/v1/connections/{connection_id}/customers")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Co\",\n  \"company_name\": \"Acme Corporation\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"bill_address\": {\n    \"addr1\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"postal_code\": \"78701\"\n  },\n  \"phone\": \"512-555-0100\",\n  \"email\": \"[email protected]\",\n  \"terms_list_id\": \"80000014-1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Co\",\n  \"company_name\": \"Acme Corporation\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"bill_address\": {\n    \"addr1\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"postal_code\": \"78701\"\n  },\n  \"phone\": \"512-555-0100\",\n  \"email\": \"[email protected]\",\n  \"terms_list_id\": \"80000014-1234567890\"\n}"

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

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "waiting",
    "request_xml": "<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>100</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "page": 1,
    "original_request_id": "550e8400-e29b-41d4-a716-446655440000",
    "iteration_state": "not_applicable",
    "request_types": [
      "CustomerQueryRq"
    ],
    "webhook_state": "not_applicable",
    "request_json": {
      "version": "13.0",
      "request": {
        "name": "CustomerQueryRq",
        "attributes": {
          "requestID": "1"
        },
        "children": [
          {
            "name": "MaxReturned",
            "text": "100"
          }
        ]
      }
    },
    "response_xml": "<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>",
    "response_json": [
      {}
    ],
    "webhook_url": "https://example.com/webhook",
    "webhook_attempts": [
      {
        "status": "succeeded",
        "sent_at": "2023-11-07T05:31:56Z",
        "error": "<string>",
        "attempted_at": "2023-11-07T05:31:56Z",
        "response": "<string>"
      }
    ],
    "webhook_error": "<string>",
    "error": {
      "error_type": "xml_error",
      "message": "<string>",
      "user_message": "<string>",
      "error_code": 123,
      "hresult": "<string>",
      "debug_message": "<string>",
      "code": "<string>",
      "details": {}
    },
    "links": {
      "self": "/api/v1/connections/123e4567-e89b-12d3-a456-426614174000/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "ui": "/app/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "connection_ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000",
      "pages": "/api/v2/connections/123e4567-e89b-12d3-a456-426614174000/queued-requests/550e8400-e29b-41d4-a716-446655440000/pages"
    },
    "inserted_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:01Z"
  }
}

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

Unauthorized

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

{
  "errors": {
    "webhook_url": [
      "must be an http or https URL"
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

connection_id

string<uuid>

required

ID of the connection to use for customer creation

Query Parameters

request_id

string

A custom ID that can be used to identify the request and response. This could be your local ID for the request.

Example:

"1"

webhook_url

string<uri>

Optional absolute http or https URL to receive a webhook when the request is completed. 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

name

string

required

Customer name as it appears in the QuickBooks customer list (must be unique)

Maximum string length: 41

is_active

boolean

Whether the customer is active

class_list_id

string

Optional class ListID

parent_list_id

string

Optional parent customer/job ListID, to create this customer as a sub-customer or job

company_name

string

Optional company name

Maximum string length: 41

salutation

string

Optional salutation (e.g. Mr., Ms., Dr.)

Maximum string length: 15

first_name

string

Optional first name

Maximum string length: 25

middle_name

string

Optional middle name/initial

Maximum string length: 5

last_name

string

Optional last name

Maximum string length: 25

suffix

string

Optional name suffix (e.g. Jr., Sr.)

job_title

string

Optional job title

Maximum string length: 41

bill_address

object

Optional bill-to address

Show child attributes

ship_address

object

Optional ship-to address

Show child attributes

ship_to_addresses

object[]

Optional additional ship-to addresses (up to 50)

Show child attributes

print_as

string

Optional name to print on checks and invoices, if different from name

Maximum string length: 41

phone

string

Optional phone number

Maximum string length: 21

mobile

string

Optional mobile phone number

Maximum string length: 21

Optional pager number

Maximum string length: 21

alt_phone

string

Optional alternate phone number

Maximum string length: 21

fax

string

Optional fax number

Maximum string length: 21

string

Optional email address

Maximum string length: 1023

string

Optional CC email address

Maximum string length: 1023

contact

string

Optional primary contact name

Maximum string length: 41

alt_contact

string

Optional alternate contact name

Maximum string length: 41

additional_contacts

object[]

Optional additional named contact methods (e.g. social handles)

Show child attributes

contacts

object[]

Optional additional named contacts at this customer

Show child attributes

customer_type_list_id

string

Optional customer type ListID

terms_list_id

string

Optional payment terms ListID

sales_rep_list_id

string

Optional sales rep ListID

open_balance

string

Optional opening balance as a decimal string

open_balance_date

string<date>

Optional opening balance date (YYYY-MM-DD), required if open_balance is set

sales_tax_code_list_id

string

Optional sales tax code ListID

item_sales_tax_list_id

string

Optional tax item or tax group ListID

sales_tax_country

enum<string>

Optional sales tax country

Available options:

Australia,

Canada,

UK,

US

resale_number

string

Optional resale number

Maximum string length: 15

account_number

string

Optional account number shown on customer statements

Maximum string length: 99

credit_limit

string

Optional credit limit as a decimal string

preferred_payment_method_list_id

string

Optional preferred payment method ListID

credit_card_info

object

Optional credit card on file

Show child attributes

job_status

enum<string>

Optional job status, if this customer represents a job

Available options:

Awarded,

Closed,

InProgress,

None,

NotAwarded,

Pending

job_start_date

string<date>

Optional job start date (YYYY-MM-DD)

job_projected_end_date

string<date>

Optional projected job end date (YYYY-MM-DD)

job_end_date

string<date>

Optional actual job end date (YYYY-MM-DD)

job_desc

string

Optional job description

Maximum string length: 99

job_type_list_id

string

Optional job type ListID

notes

string

Optional freeform notes

Maximum string length: 4095

additional_notes

string[]

Optional dated notes to attach to the customer

Maximum string length: 4095

is_statement_with_parent

boolean

Whether to include this job's transactions on the parent customer's statement (only applies to jobs)

delivery_method

enum<string>

Optional delivery method

Available options:

Email,

Fax,

Print

preferred_delivery_method

enum<string>

Optional preferred delivery method

Available options:

None,

Email,

Fax

price_level_list_id

string

Optional price level ListID

external_guid

string

Optional external GUID for cross-referencing this customer in another system

tax_registration_number

string

Optional tax registration number (e.g. VAT number)

Maximum string length: 30

currency_list_id

string

Optional currency ListID, for multi-currency companies

Response

Customer create request accepted and queued for processing. Returns a queued request object.

data

object

Show child attributes

Overview

API v2

API v1 (legacy)

Create Customer

Authorizations

Path Parameters

Query Parameters

Body

Response