v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

accounting/addresses

Retrieve Addresses

Retrieve Addresses from any connected Accounting software

get/accounting/addresses/{id}

Path parameters

idstring required

id of the address 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

typestring nullable

The type of the address

street_1string nullable

The first line of the street address

street_2string nullable

The second line of the street address

citystring nullable

The city of the address

statestring nullable

The state of the address

country_subdivisionstring nullable

The country subdivision (e.g., province or state) of the address

countrystring nullable

The country of the address

zipstring nullable

The zip or postal code of the address

contact_idstring nullable

The UUID of the associated contact

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 address record

remote_idstring nullable

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

remote_dataobject nullable

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

created_atstring date-time nullable

The created date of the address record

modified_atstring date-time nullable

The last modified date of the address record

Example response

{
  "type": "Billing",
  "street_1": "123 Main St",
  "street_2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "country_subdivision": "New York",
  "country": "USA",
  "zip": "10001",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "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": "address_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z"
}