Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
accounting/contacts

Retrieve Contacts

Retrieve Contacts from any connected Accounting software

get/accounting/contacts/{id}

Path parameters

idstring required

id of the contact you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Accounting software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable

The name of the contact

is_supplierboolean nullable

Indicates if the contact is a supplier

is_customerboolean nullable

Indicates if the contact is a customer

email_addressstring nullable

The email address of the contact

tax_numberstring nullable

The tax number of the contact

statusstring nullable

The status of the contact

currencystring nullable

The currency associated with the contact

remote_updated_atstring nullable

The date when the contact was last updated in the remote system

company_info_idstring nullable

The UUID of the associated company info

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the contact record

remote_idstring nullable

The remote ID of the contact in the context of the 3rd Party

remote_dataobject nullable

The remote data of the contact in the context of the 3rd Party

created_atstring date-time nullable

The created date of the contact record

modified_atstring date-time nullable

The last modified date of the contact record

Example response

{
  "name": "John Doe",
  "is_supplier": true,
  "email_address": "john.doe@example.com",
  "tax_number": "123456789",
  "status": "Active",
  "currency": "USD",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "contact_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z"
}