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

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

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

run();
{
  "transaction_date": "2024-06-15T12:00:00Z",
  "status": "Issued",
  "number": "CN-001",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "exchange_rate": "1.2",
  "total_amount": 10000,
  "remaining_credit": 5000,
  "tracking_categories": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "currency": "USD",
  "payments": [
    "PAYMENT-001",
    "PAYMENT-002"
  ],
  "applied_payments": [
    "APPLIED-001",
    "APPLIED-002"
  ],
  "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "creditnote_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-06-15T12:00:00Z",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "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 creditnote you want to retrieve.

Query Parameters

​
remote_data
boolean

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

Response

200 - application/json
​
transaction_date
string | null

The date of the credit note transaction

Example:

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

​
status
string | null

The status of the credit note

Example:

"Issued"

​
number
string | null

The number of the credit note

Example:

"CN-001"

​
contact_id
string | null

The UUID of the associated contact

Example:

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

​
company_id
string | null

The UUID of the associated company

Example:

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

​
exchange_rate
string | null

The exchange rate applied to the credit note

Example:

"1.2"

​
total_amount
number | null

The total amount of the credit note

Example:

10000

​
remaining_credit
number | null

The remaining credit on the credit note

Example:

5000

​
tracking_categories
string[] | null

The UUIDs of the tracking categories associated with the credit note

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

The currency of the credit note

Example:

"USD"

​
payments
string[] | null

The payments associated with the credit note

Example:
["PAYMENT-001", "PAYMENT-002"]
​
applied_payments
string[] | null

The applied payments associated with the credit note

Example:
["APPLIED-001", "APPLIED-002"]
​
accounting_period_id
string | null

The UUID of the associated accounting period

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 credit note record

Example:

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

​
remote_id
string | null

The remote ID of the credit note in the context of the 3rd Party

Example:

"creditnote_1234"

​
remote_data
object | null

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

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

The date when the credit note was created in the remote system

Example:

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

​
remote_updated_at
string | null

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

Example:

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

​
created_at
string | null

The created date of the credit note record

Example:

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

​
modified_at
string | null

The last modified date of the credit note record

Example:

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