Addresses
The
Address
object is used to represent a contact's or company's address.Properties
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
type
EnumOptional
The address type. Possible values include:
BILLING
, SHIPPING
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.street_1
StringOptional
Line 1 of the address's street.
street_2
StringOptional
Line 2 of the address's street.
city
StringOptional
The address's city.
state
AnyOptional
The address's state or region.
country_subdivision
StringOptional
The address's state or region.
country
EnumOptional
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
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.zip_code
StringOptional
The address's zip code.
GET
/addresses/{id}
https://api.merge.dev/api/accounting/v1/addresses/{id}
US
EU
APAC
Returns an Address
object with the given id
.
Query & Path Parameters
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
show_enum_origins
StringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstate
Anystreet_1
Stringstreet_2
Stringtype
Enumzip_code
StringMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstate
Anystreet_1
Stringstreet_2
Stringtype
Enumzip_code
StringMicrosoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstreet_1
Stringstreet_2
Stringzip_code
StringMoneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumstreet_1
Stringstreet_2
Stringzip_code
StringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstreet_1
Stringstreet_2
Stringtype
Enumzip_code
StringQuickBooks Desktop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstate
Anystreet_1
Stringstreet_2
Stringtype
Enumzip_code
StringQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstate
Anystreet_1
Stringstreet_2
Stringtype
Enumzip_code
StringSage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstreet_1
Stringstreet_2
Stringzip_code
StringSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumcountry_subdivision
Stringstreet_1
Stringstreet_2
Stringtype
Enumzip_code
StringWave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumstreet_1
Stringstreet_2
Stringzip_code
StringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumstate
Anystreet_1
Stringstreet_2
Stringzip_code
StringZoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
city
Stringcountry
Enumstate
Anystreet_1
Stringstreet_2
Stringtype
Enumzip_code
String