Retrieve Purchase Orders - Panora Documentation

GET

accounting

purchaseorders

{id}

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

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

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

run();

{
  "status": "Pending",
  "issue_date": "2024-06-15T12:00:00Z",
  "purchase_order_number": "PO-001",
  "delivery_date": "2024-07-15T12:00:00Z",
  "delivery_address": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "customer": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "vendor": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "memo": "Purchase order for Q3 inventory",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "total_amount": 100000,
  "currency": "USD",
  "exchange_rate": "1.2",
  "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": "po_1234",
  "remote_created_at": "2024-06-15T12:00:00Z",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "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

string

required

id of the purchaseorder you want to retrieve.

Query Parameters

remote_data

boolean

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

Response

200 - application/json

status

string | null

The status of the purchase order

Example:

"Pending"

issue_date

string | null

The issue date of the purchase order

Example:

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

purchase_order_number

string | null

The purchase order number

Example:

"PO-001"

delivery_date

string | null

The delivery date for the purchase order

Example:

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

delivery_address

string | null

The UUID of the delivery address

Example:

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

customer

string | null

The UUID of the customer

Example:

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

vendor

string | null

The UUID of the vendor

Example:

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

memo

string | null

A memo or note for the purchase order

Example:

"Purchase order for Q3 inventory"

company_id

string | null

The UUID of the company

Example:

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

total_amount

number | null

The total amount of the purchase order in cents

Example:

100000

currency

string | null

The currency of the purchase order

Example:

"USD"

exchange_rate

string | null

The exchange rate applied to the purchase order

Example:

"1.2"

tracking_categories

string[] | null

The UUIDs of the tracking categories associated with the purchase order

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 purchase order

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

string | null

The UUID of the purchase order record

Example:

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

remote_id

string | null

The remote ID of the purchase order in the context of the 3rd Party

Example:

"po_1234"

remote_created_at

string | null

The date when the purchase order was created in the remote system

Example:

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

remote_updated_at

string | null

The date when the purchase order was last updated in the remote system

Example:

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

remote_data

object | null

The remote data of the purchase order in the context of the 3rd Party

Example:

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

created_at

string | null

The created date of the purchase order record

Example:

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

modified_at

string | null

The last modified date of the purchase order record

Example:

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

Was this page helpful?

Suggest edits Raise issue

List PurchaseOrders Create Purchase Orders

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

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

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

run();

{
  "status": "Pending",
  "issue_date": "2024-06-15T12:00:00Z",
  "purchase_order_number": "PO-001",
  "delivery_date": "2024-07-15T12:00:00Z",
  "delivery_address": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "customer": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "vendor": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "memo": "Purchase order for Q3 inventory",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "total_amount": 100000,
  "currency": "USD",
  "exchange_rate": "1.2",
  "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": "po_1234",
  "remote_created_at": "2024-06-15T12:00:00Z",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "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

Path Parameters

Query Parameters

Response