UNunified
accounting
contact

Retrieve a contact

Changed on

Retrieves a single AccountingContact by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/accounting/{connection_id}/contact/{id}

Request

  • Base URL
    https://api.unified.to
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Contact

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The contact's display name: the company name for a business, or the person's full name

first_namestring
last_namestring
currencystring
is_activeboolean
tax_exemption'FEDERAL_GOV' | 'REGION_GOV' | 'LOCAL_GOV' | 'TRIBAL_GOV' | 'CHARITABLE_ORG' | 'RELIGIOUS_ORG' | 'EDUCATIONAL_ORG' | 'MEDICAL_ORG' | 'RESALE' | 'FOREIGN' | 'OTHER'
tax_numberstring

The ID/number of the customer's tax number. This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global).

is_customerboolean
is_supplierboolean
portal_urlstring

URL for the contact’s portal

company_namestring
identificationstring

contact account numbers such as registration, A membership or identification reference to help to identify and search customers

organization_idstring
payment_terms'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'
paymentterm_idstring
balance_amountnumber

Outstanding AR/AP balance for this contact

websitestring
notesstring
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • fbf77d34910fRevision changes
    • info

      added the enum value balance_amount to the property items/ of the query request parameter fields

    • info

      added the enum value notes to the property items/ of the query request parameter fields

    • info

      added the enum value website to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status