GET api/companies/GetCompanyInfo?customerId={customerId}&vendorId={vendorId}&isVendor={isVendor}

Get customer/vendor info for which to be added into QBO

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	Customer ID	integer	Required
vendorId	Vendor ID	integer	Required
isVendor	is for creating a vendor in QBO?	boolean	Required

Body Parameters

None.

Response Information

Resource Description

CustomerInfo

Name	Type	Additional information
Taxable	boolean	None.
BillAddr	PhysicalAddress	None.
ShipAddr	PhysicalAddress	None.
Term	integer	None.
PaymentMethod	integer	None.
Balance	decimal number	None.
BalanceWithJobs	decimal number	None.
Notes	string	None.
Title	string	None.
GivenName	string	None.
MiddleName	string	None.
FamilyName	string	None.
Suffix	string	None.
FullyQualifiedName	string	None.
CompanyName	string	None.
DisplayName	string	None.
PrintOnCheckName	string	None.
Active	boolean	None.
primaryPhone	TelephoneNumber	None.
FreeFormNumber	string	None.
alternatePhone	TelephoneNumber	None.
mobile	TelephoneNumber	None.
fax	TelephoneNumber	None.
primaryEmailAddr	EmailAddress	None.
webAddr	WebSiteAddress	None.
CurrencyText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "taxable": true,
  "billAddr": {
    "id": "sample string 1",
    "line1": "sample string 2",
    "line2": "sample string 3",
    "line3": "sample string 4",
    "line4": "sample string 5",
    "line5": "sample string 6",
    "city": "sample string 7",
    "country": "sample string 8",
    "countryCode": "sample string 9",
    "county": "sample string 10",
    "countrySubDivisionCode": "sample string 11",
    "postalCode": "sample string 12",
    "postalCodeSuffix": "sample string 13",
    "lat": "sample string 14",
    "long": "sample string 15",
    "tag": "sample string 16",
    "note": "sample string 17"
  },
  "shipAddr": {
    "id": "sample string 1",
    "line1": "sample string 2",
    "line2": "sample string 3",
    "line3": "sample string 4",
    "line4": "sample string 5",
    "line5": "sample string 6",
    "city": "sample string 7",
    "country": "sample string 8",
    "countryCode": "sample string 9",
    "county": "sample string 10",
    "countrySubDivisionCode": "sample string 11",
    "postalCode": "sample string 12",
    "postalCodeSuffix": "sample string 13",
    "lat": "sample string 14",
    "long": "sample string 15",
    "tag": "sample string 16",
    "note": "sample string 17"
  },
  "term": 1,
  "paymentMethod": 2,
  "balance": 3.0,
  "balanceWithJobs": 4.0,
  "notes": "sample string 5",
  "title": "sample string 6",
  "givenName": "sample string 7",
  "middleName": "sample string 8",
  "familyName": "sample string 9",
  "suffix": "sample string 10",
  "fullyQualifiedName": "sample string 11",
  "companyName": "sample string 12",
  "displayName": "sample string 13",
  "printOnCheckName": "sample string 14",
  "active": true,
  "primaryPhone": {
    "id": "sample string 1",
    "deviceType": "sample string 2",
    "countryCode": "sample string 3",
    "areaCode": "sample string 4",
    "exchangeCode": "sample string 5",
    "extension": "sample string 6",
    "freeFormNumber": "sample string 7",
    "default": true,
    "tag": "sample string 10"
  },
  "freeFormNumber": "sample string 16",
  "alternatePhone": {
    "id": "sample string 1",
    "deviceType": "sample string 2",
    "countryCode": "sample string 3",
    "areaCode": "sample string 4",
    "exchangeCode": "sample string 5",
    "extension": "sample string 6",
    "freeFormNumber": "sample string 7",
    "default": true,
    "tag": "sample string 10"
  },
  "mobile": {
    "id": "sample string 1",
    "deviceType": "sample string 2",
    "countryCode": "sample string 3",
    "areaCode": "sample string 4",
    "exchangeCode": "sample string 5",
    "extension": "sample string 6",
    "freeFormNumber": "sample string 7",
    "default": true,
    "tag": "sample string 10"
  },
  "fax": {
    "id": "sample string 1",
    "deviceType": "sample string 2",
    "countryCode": "sample string 3",
    "areaCode": "sample string 4",
    "exchangeCode": "sample string 5",
    "extension": "sample string 6",
    "freeFormNumber": "sample string 7",
    "default": true,
    "tag": "sample string 10"
  },
  "primaryEmailAddr": {
    "id": "sample string 1",
    "address": "sample string 2",
    "default": true,
    "tag": "sample string 5"
  },
  "webAddr": {
    "id": "sample string 1",
    "uri": "sample string 2",
    "default": true,
    "tag": "sample string 5"
  },
  "currencyText": "sample string 17"
}