List CreditNotes - Panora Documentation

GET

accounting

creditnotes

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

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

async function run() {
  const result = await panora.accounting.creditnotes.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "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

Query Parameters

remote_data

boolean

Set to true to include data from the original software.

limit

number

default:50

Set to get the number of records.

cursor

string

Set to get the number of records after this cursor.

Response

200 - application/json

prev_cursor

string | null

required

next_cursor

string | null

required

data

object[]

required

data.transaction_date

string | null

The date of the credit note transaction

Example:

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

data.status

string | null

The status of the credit note

Example:

"Issued"

data.number

string | null

The number of the credit note

Example:

"CN-001"

data.contact_id

string | null

The UUID of the associated contact

Example:

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

data.company_id

string | null

The UUID of the associated company

Example:

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

data.exchange_rate

string | null

The exchange rate applied to the credit note

Example:

"1.2"

data.total_amount

number | null

The total amount of the credit note

Example:

10000

data.remaining_credit

number | null

The remaining credit on the credit note

Example:

5000

data.tracking_categories

string[] | null

The UUIDs of the tracking categories associated with the credit note

Example:

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

data.currency

string | null

The currency of the credit note

Example:

"USD"

data.payments

string[] | null

The payments associated with the credit note

Example:

["PAYMENT-001", "PAYMENT-002"]

data.applied_payments

string[] | null

The applied payments associated with the credit note

Example:

["APPLIED-001", "APPLIED-002"]

data.accounting_period_id

string | null

The UUID of the associated accounting period

Example:

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

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

data.id

string | null

The UUID of the credit note record

Example:

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

data.remote_id

string | null

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

Example:

"creditnote_1234"

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

data.remote_created_at

string | null

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

Example:

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

data.remote_updated_at

string | null

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

Example:

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

data.created_at

string | null

The created date of the credit note record

Example:

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

data.modified_at

string | null

The last modified date of the credit note record

Example:

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

Retrieve Contacts Retrieve Credit Notes

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

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

async function run() {
  const result = await panora.accounting.creditnotes.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });
  
  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "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"
    }
  ]
}

Accounting Objects

Authorizations

Headers

Query Parameters

Response