Addresses

The Address object is used to represent a contact's or company's address.

The Address object

Properties


street_1String
Optional
Line 1 of the address's street.

street_2String
Optional
Line 2 of the address's street.

cityString
Optional
The address's city.

stateEnum
Optional
The address's state. Possible values include: AL, AK, AS, AZ, AR, AA, AE, AP, CA, CO, CT, DE, DC, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY, or - in cases where there is no clear mapping - the original value passed through.

countryEnum
Optional
The address's country. Possible values include: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, or - in cases where there is no clear mapping - the original value passed through.

zip_codeString
Optional
The address's zip code.

The Address object

{
  "street_1": "2920 Broadway",
  "street_2": "2nd Floor",
  "city": "New York",
  "state": "NY",
  "country": "USA",
  "zip_code": "10027"
}

GET

/addresses/{id}

Returns an Address object with the given id.


Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "street_1": "2920 Broadway",
  "street_2": "2nd Floor",
  "city": "New York",
  "state": "NY",
  "country": "USA",
  "zip_code": "10027"
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

countryEnum

street_1String

stateEnum

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

street_1String

stateEnum

countryEnum