List Addresss - Panora Documentation

GET

accounting

addresses

import { Panora } from "@panora/sdk";

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

async function run() {
  const result = await panora.accounting.addresses.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "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

Query Parameters

remote_data

boolean

Set to true to include data from the original software.

limit

number

default:50

Set to get the number of records.

cursor

string

Set to get the number of records after this cursor.

Response

200 - application/json

prev_cursor

string | null

required

next_cursor

string | null

required

data

object[]

required

data.type

string | null

The type of the address

Example:

"Billing"

data.street_1

string | null

The first line of the street address

Example:

"123 Main St"

data.street_2

string | null

The second line of the street address

Example:

"Apt 4B"

data.city

string | null

The city of the address

Example:

"New York"

data.state

string | null

The state of the address

Example:

"NY"

data.country_subdivision

string | null

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

Example:

"New York"

data.country

string | null

The country of the address

Example:

"USA"

data.zip

string | null

The zip or postal code of the address

Example:

"10001"

data.contact_id

string | null

The UUID of the associated contact

Example:

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

data.company_info_id

string | null

The UUID of the associated company info

Example:

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

data.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"
}

data.id

string | null

The UUID of the address record

Example:

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

data.remote_id

string | null

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

Example:

"address_1234"

data.remote_data

object | null

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

Example:

{
  "raw_data": { "additional_field": "some value" }
}

data.created_at

string | null

The created date of the address record

Example:

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

data.modified_at

string | null

The last modified date of the address record

Example:

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

Was this page helpful?

Suggest edits Raise issue

Retrieve Accounts Retrieve Addresses

import { Panora } from "@panora/sdk";

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

async function run() {
  const result = await panora.accounting.addresses.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "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"
    }
  ]
}

Accounting Objects

Authorizations

Headers

Query Parameters

Response