Merge Accounting - Addresses

Addresses

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

The Address object

Properties

typeEnum

Optional

The address type. Possible values include: BILLING, SHIPPING, or - in cases where there is no clear mapping - the original value passed through.

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.

stateAny

Optional

The address's state or region.

country_subdivisionString

Optional

The address's state or region.

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.

modified_atString

Required

This is the datetime that this object was last updated by Merge

The Address object

JSON


{
  "type": "SHIPPING",
  "street_1": "2920 Broadway",
  "street_2": "2nd Floor",
  "city": "New York",
  "state": "NY",
  "country_subdivision": "NY",
  "country": "USA",
  "zip_code": "10027",
  "modified_at": "2021-10-16T00:00:00Z"
}

GET

/addresses/{id}

Returns an Address object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

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.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

Which fields should be returned in non-normalized form.

Response

JSON


{
  "type": "SHIPPING",
  "street_1": "2920 Broadway",
  "street_2": "2nd Floor",
  "city": "New York",
  "state": "NY",
  "country_subdivision": "NY",
  "country": "USA",
  "zip_code": "10027",
  "modified_at": "2021-10-16T00:00:00Z"
}