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

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

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

run();
{
  "file_name": "invoice.pdf",
  "file_url": "https://example.com/files/invoice.pdf",
  "account_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "attachment_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 attachment you want to retrieve.

Query Parameters

​
remote_data
boolean

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

Response

200 - application/json
​
file_name
string | null

The name of the attached file

Example:

"invoice.pdf"

​
file_url
string | null

The URL where the file can be accessed

Example:

"https://example.com/files/invoice.pdf"

​
account_id
string | null

The UUID of the associated account

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

Example:

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

​
remote_id
string | null

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

Example:

"attachment_1234"

​
remote_data
object | null

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

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

The created date of the attachment record

Example:

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

​
modified_at
string | null

The last modified date of the attachment record

Example:

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

Was this page helpful?

Suggest editsRaise issue