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

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

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

run();
{
  "number": "VC-001",
  "transaction_date": "2024-06-15T12:00:00Z",
  "vendor": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "total_amount": "1000",
  "currency": "USD",
  "exchange_rate": "1.2",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "tracking_categories": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "line_items": [
    {
      "name": "Net Income",
      "value": 100000,
      "type": "Operating Activities",
      "parent_item": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "report_item_1234",
      "remote_generated_at": "2024-07-01T12:00:00Z",
      "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "created_at": "2024-06-15T12:00:00Z",
      "modified_at": "2024-06-15T12:00:00Z"
    }
  ],
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "remote_id_1234",
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-connection-token
string
required

The connection token

Path Parameters

​
id
string
required

id of the vendorcredit 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 number of the vendor credit

Example:

"VC-001"

​
transaction_date
string | null

The date of the transaction

Example:

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

​
vendor
string | null

The UUID of the vendor associated with the credit

Example:

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

​
total_amount
string | null

The total amount of the vendor credit

Example:

"1000"

​
currency
string | null

The currency of the vendor credit

Example:

"USD"

​
exchange_rate
string | null

The exchange rate applied to the vendor credit

Example:

"1.2"

​
company_id
string | null

The UUID of the associated company

Example:

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

​
tracking_categories
string[] | null

The UUID of the tracking categories associated with the vendor credit

Example:
["801f9ede-c698-4e66-a7fc-48d19eebaa4f"]
​
accounting_period_id
string | null

The UUID of the associated accounting period

Example:

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

​
line_items
object[]

The line items associated with this vendor credit

​
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 vendor credit record

Example:

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

​
remote_id
string | null

The remote ID of the vendor credit

Example:

"remote_id_1234"

​
created_at
string

The created date of the vendor credit

Example:

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

​
modified_at
string

The last modified date of the vendor credit

Example:

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

​
remote_updated_at
string | null

The date when the vendor credit was last updated in the remote system

Example:

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

​
remote_data
object | null

The remote data of the vendor credit in the context of the 3rd Party

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

Was this page helpful?

Suggest editsRaise issue
Retrieve TransactionsList VendorCredits