A Contact
is an individual or business entity to which products and services are sold to or purchased from. The Contact
model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from.
- A
Contact
is a Vendor/Supplier if theis_supplier
property is true. - A
Contact
is a customer if theis_customer
property is true.
id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)name
Stringis_supplier
Booleanis_customer
Booleanemail_address
Stringtax_number
Stringstatus
EnumACTIVE
, ARCHIVED
. 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.currency
Stringremote_updated_at
DateTime (ISO 8601)company
UUIDaddresses
Address[]Address
object IDs for the given Contacts
object.Address
object is used to represent a contact's or company's address.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)type
EnumBILLING
, 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
Stringstreet_2
Stringcity
Stringstate
Anycountry_subdivision
Stringcountry
EnumAF
, 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
Stringphone_numbers
AccountingPhoneNumber[]AccountingPhoneNumber
object for the given Contacts
object.AccountingPhoneNumber
object is used to represent a contact's or company's phone number.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)number
Stringtype
Stringremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]remote_fields
RemoteField[]https://api.merge.dev/api/accounting/v1/contacts
Returns a list of Contact
objects.
company_id
Stringcreated_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemail_address
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleaninclude_shell_data
Booleanis_customer
Stringis_supplier
Stringmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)name
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
StringSupported Response Fields
email_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry
stringzip_code
stringemail_address
Stringname
Stringphone_numbers
AccountingPhoneNumber[]number
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
EnumSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
EnumSupported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumhttps://api.merge.dev/api/accounting/v1/contacts
Creates a Contact
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringis_supplier
Booleanis_customer
Booleanemail_address
Stringtax_number
Stringstatus
EnumACTIVE
, ARCHIVED
.currency
Stringcompany
UUIDid
field in the Company object.addresses
ArrayAddress
object IDs for the given Contacts
object.phone_numbers
ArrayAccountingPhoneNumber
object for the given Contacts
object.integration_params
Objectlinked_account_params
Objectremote_fields
ArraySupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringtype
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]created_at
stringmodified_at
stringnumber
stringtype
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringtype
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]created_at
stringmodified_at
stringnumber
stringtype
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringtype
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]created_at
stringmodified_at
stringnumber
stringtype
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
EnumAdditional POST Parameters
integration_params
Objectis_person
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringtype
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]created_at
stringmodified_at
stringnumber
stringtype
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringtype
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringAdditional POST Parameters
remote_fields
Objectremote_field_class
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringtype
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]created_at
stringmodified_at
stringnumber
stringtype
stringremote_id
Stringstatus
Enumtax_number
Stringhttps://api.merge.dev/api/accounting/v1/contacts/{id}
Returns a Contact
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleaninclude_remote_fields
Booleanremote_fields
Stringshow_enum_origins
StringSupported Response Fields
email_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry
stringzip_code
stringemail_address
Stringname
Stringphone_numbers
AccountingPhoneNumber[]number
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
EnumSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringstate
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tax_number
StringSupported Response Fields
addresses
Address[]type
stringstreet_1
stringstreet_2
stringcity
stringcountry_subdivision
stringcountry
stringzip_code
stringcompany
UUIDcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtax_number
StringSupported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringcountry
stringzip_code
stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringphone_numbers
AccountingPhoneNumber[]number
stringtype
stringremote_data
RemoteData[]path
string