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

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

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

run();
{
  "name": "Cash",
  "description": "Main cash account for daily operations",
  "classification": "Asset",
  "type": "Current Asset",
  "status": "Active",
  "current_balance": 10000,
  "currency": "USD",
  "account_number": "1000",
  "parent_account": "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": "account_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 account you want to retrieve.

Query Parameters

​
remote_data
boolean

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

Response

200 - application/json
​
name
string | null

The name of the account

Example:

"Cash"

​
description
string | null

A description of the account

Example:

"Main cash account for daily operations"

​
classification
string | null

The classification of the account

Example:

"Asset"

​
type
string | null

The type of the account

Example:

"Current Asset"

​
status
string | null

The status of the account

Example:

"Active"

​
current_balance
number | null

The current balance of the account

Example:

10000

​
currency
string | null

The currency of the account

Example:

"USD"

​
account_number
string | null

The account number

Example:

"1000"

​
parent_account
string | null

The UUID of the parent account

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

Example:

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

​
remote_id
string | null

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

Example:

"account_1234"

​
remote_data
object | null

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

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

The created date of the account record

Example:

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

​
modified_at
string | null

The last modified date of the account record

Example:

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

Was this page helpful?

Suggest editsRaise issue