Retrieve Phone Numbers - Panora Documentation

GET

accounting

phonenumbers

{id}

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

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

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

run();

{
  "number": "+1234567890",
  "type": "Mobile",
  "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "phone_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

string

required

id of the phonenumber you want to retrieve.

Query Parameters

remote_data

boolean

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

Response

200 - application/json

number

string | null

The phone number

Example:

"+1234567890"

type

string | null

The type of phone number

Example:

"Mobile"

company_info_id

string | null

The UUID of the associated company info

Example:

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

contact_id

string

The UUID of the associated contact

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

string | null

The UUID of the phone number record

Example:

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

remote_id

string | null

The remote ID of the phone number in the context of the 3rd Party

Example:

"phone_1234"

remote_data

object | null

The remote data of the phone number in the context of the 3rd Party

Example:

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

created_at

string | null

The created date of the phone number record

Example:

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

modified_at

string | null

The last modified date of the phone number record

Example:

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

Was this page helpful?

Suggest edits Raise issue

Retrieve Payments List PhoneNumbers

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

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

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

run();

{
  "number": "+1234567890",
  "type": "Mobile",
  "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "phone_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

Path Parameters

Query Parameters

Response