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

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

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

run();
{
  "name": "Q2 2024 Cash Flow Statement",
  "currency": "USD",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "start_period": "2024-04-01T00:00:00Z",
  "end_period": "2024-06-30T23:59:59Z",
  "cash_at_beginning_of_period": 1000000,
  "cash_at_end_of_period": 1200000,
  "remote_generated_at": "2024-07-01T12:00:00Z",
  "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": "cashflowstatement_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 cashflowstatement you want to retrieve.

Query Parameters

​
remote_data
boolean

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

Response

200 - application/json
​
name
string | null

The name of the cash flow statement

Example:

"Q2 2024 Cash Flow Statement"

​
currency
string | null

The currency used in the cash flow statement

Example:

"USD"

​
company_id
string | null

The UUID of the associated company

Example:

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

​
start_period
string | null

The start date of the period covered by the cash flow statement

Example:

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

​
end_period
string | null

The end date of the period covered by the cash flow statement

Example:

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

​
cash_at_beginning_of_period
number | null

The cash balance at the beginning of the period

Example:

1000000

​
cash_at_end_of_period
number | null

The cash balance at the end of the period

Example:

1200000

​
remote_generated_at
string | null

The date when the cash flow statement was generated in the remote system

Example:

"2024-07-01T12:00:00Z"

​
line_items
object[]

The report items associated with this cash flow statement

​
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 cash flow statement record

Example:

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

​
remote_id
string | null

The remote ID of the cash flow statement in the context of the 3rd Party

Example:

"cashflowstatement_1234"

​
remote_data
object | null

The remote data of the cash flow statement in the context of the 3rd Party

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

The created date of the cash flow statement record

Example:

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

​
modified_at
string | null

The last modified date of the cash flow statement record

Example:

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