GET
/
accounting
/
addresses
/
{id}
import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.accounting.addresses.retrieve({
    xConnectionToken: "<value>",
    id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    remoteData: false,
  });
  
  // Handle the result
  console.log(result)
}

run();
{
  "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"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-connection-token
string
required

The connection token

Path Parameters

​
id
string
required

id of the address you want to retrieve.

Query Parameters

​
remote_data
boolean

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

Response

200 - application/json
​
type
string | null

The type of the address

Example:

"Billing"

​
street_1
string | null

The first line of the street address

Example:

"123 Main St"

​
street_2
string | null

The second line of the street address

Example:

"Apt 4B"

​
city
string | null

The city of the address

Example:

"New York"

​
state
string | null

The state of the address

Example:

"NY"

​
country_subdivision
string | null

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

Example:

"New York"

​
country
string | null

The country of the address

Example:

"USA"

​
zip
string | null

The zip or postal code of the address

Example:

"10001"

​
contact_id
string | null

The UUID of the associated contact

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
company_info_id
string | null

The UUID of the associated company info

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
field_mappings
object | null

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

Example:
{
  "custom_field_1": "value1",
  "custom_field_2": "value2"
}
​
id
string | null

The UUID of the address record

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
remote_id
string | null

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

Example:

"address_1234"

​
remote_data
object | null

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

Example:
{
  "raw_data": { "additional_field": "some value" }
}
​
created_at
string | null

The created date of the address record

Example:

"2024-06-15T12:00:00Z"

​
modified_at
string | null

The last modified date of the address record

Example:

"2024-06-15T12:00:00Z"

Was this page helpful?

Suggest editsRaise issue