List IncomeStatements - Panora Documentation

GET

accounting

incomestatements

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

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

async function run() {
  const result = await panora.accounting.incomestatements.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": [
    {
      "name": "Q2 2024 Income Statement",
      "currency": "USD",
      "start_period": "2024-04-01T00:00:00Z",
      "end_period": "2024-06-30T23:59:59Z",
      "gross_profit": 1000000,
      "net_operating_income": 800000,
      "net_income": 750000,
      "field_mappings": {
        "custom_field_1": "value1",
        "custom_field_2": "value2"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "incomestatement_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

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.name

string | null

The name of the income statement

Example:

"Q2 2024 Income Statement"

data.currency

string | null

The currency used in the income statement

Example:

"USD"

data.start_period

string | null

The start date of the period covered by the income statement

Example:

"2024-04-01T00:00:00Z"

data.end_period

string | null

The end date of the period covered by the income statement

Example:

"2024-06-30T23:59:59Z"

data.gross_profit

number | null

The gross profit for the period

Example:

1000000

data.net_operating_income

number | null

The net operating income for the period

Example:

800000

data.net_income

number | null

The net income for the period

Example:

750000

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 income statement record

Example:

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

data.remote_id

string | null

The remote ID of the income statement in the context of the 3rd Party

Example:

"incomestatement_1234"

data.remote_data

object | null

The remote data of the income statement in the context of the 3rd Party

Example:

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

data.created_at

string | null

The created date of the income statement record

Example:

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

data.modified_at

string | null

The last modified date of the income statement record

Example:

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

Retrieve Expenses Retrieve Income Statements

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

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

async function run() {
  const result = await panora.accounting.incomestatements.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": [
    {
      "name": "Q2 2024 Income Statement",
      "currency": "USD",
      "start_period": "2024-04-01T00:00:00Z",
      "end_period": "2024-06-30T23:59:59Z",
      "gross_profit": 1000000,
      "net_operating_income": 800000,
      "net_income": 750000,
      "field_mappings": {
        "custom_field_1": "value1",
        "custom_field_2": "value2"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "incomestatement_1234",
      "remote_data": {
        "raw_data": {
          "additional_field": "some value"
        }
      },
      "created_at": "2024-06-15T12:00:00Z",
      "modified_at": "2024-06-15T12:00:00Z"
    }
  ]
}

Accounting Objects

Authorizations

Headers

Query Parameters

Response