POST
/
accounting
/
invoices
import { Panora } from "@panora/sdk";

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

async function run() {
  const result = await panora.accounting.invoices.create({
    xConnectionToken: "<value>",
    remoteData: false,
    unifiedAccountingInvoiceInput: {
      type: "Sales",
      number: "INV-001",
      issueDate: new Date("2024-06-15T12:00:00Z"),
      dueDate: new Date("2024-07-15T12:00:00Z"),
      paidOnDate: new Date("2024-07-10T12:00:00Z"),
      memo: "Payment for services rendered",
      currency: "USD",
      exchangeRate: "1.2",
      totalDiscount: 1000,
      subTotal: 10000,
      status: "Paid",
      totalTaxAmount: 1000,
      totalAmount: 11000,
      balance: 0,
      contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      accountingPeriodId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      trackingCategories: [
        "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
        "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      ],
      lineItems: [
        {
          name: "Net Income",
          value: 100000,
          type: "Operating Activities",
          parentItem: "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
          remoteId: "report_item_1234",
          remoteGeneratedAt: new Date("2024-07-01T12:00:00Z"),
          companyInfoId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
          createdAt: new Date("2024-06-15T12:00:00Z"),
          modifiedAt: new Date("2024-06-15T12:00:00Z"),
        },
      ],
      fieldMappings: {},
    },
  });
  
  // Handle the result
  console.log(result)
}

run();
{
  "type": "Sales",
  "number": "INV-001",
  "issue_date": "2024-06-15T12:00:00Z",
  "due_date": "2024-07-15T12:00:00Z",
  "paid_on_date": "2024-07-10T12:00:00Z",
  "memo": "Payment for services rendered",
  "currency": "USD",
  "exchange_rate": "1.2",
  "total_discount": 1000,
  "sub_total": 10000,
  "status": "Paid",
  "total_tax_amount": 1000,
  "total_amount": 11000,
  "balance": 0,
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "tracking_categories": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "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": "invoice_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "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 Accounting software.

Body

application/json
​
type
string | null

The type of the invoice

Example:

"Sales"

​
number
string | null

The invoice number

Example:

"INV-001"

​
issue_date
string | null

The date the invoice was issued

Example:

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

​
due_date
string | null

The due date of the invoice

Example:

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

​
paid_on_date
string | null

The date the invoice was paid

Example:

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

​
memo
string | null

A memo or note on the invoice

Example:

"Payment for services rendered"

​
currency
string | null

The currency of the invoice

Example:

"USD"

​
exchange_rate
string | null

The exchange rate applied to the invoice

Example:

"1.2"

​
total_discount
number | null

The total discount applied to the invoice

Example:

1000

​
sub_total
number | null

The subtotal of the invoice

Example:

10000

​
status
string | null

The status of the invoice

Example:

"Paid"

​
total_tax_amount
number | null

The total tax amount on the invoice

Example:

1000

​
total_amount
number | null

The total amount of the invoice

Example:

11000

​
balance
number | null

The remaining balance on the invoice

Example:

0

​
contact_id
string | null

The UUID of the associated contact

Example:

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

​
accounting_period_id
string | null

The UUID of the associated accounting period

Example:

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

​
tracking_categories
string[] | null

The UUIDs of the tracking categories associated with the invoice

Example:
[
  "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
]
​
line_items
object[]

The line items associated with this invoice

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

Response

201 - application/json
​
type
string | null

The type of the invoice

Example:

"Sales"

​
number
string | null

The invoice number

Example:

"INV-001"

​
issue_date
string | null

The date the invoice was issued

Example:

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

​
due_date
string | null

The due date of the invoice

Example:

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

​
paid_on_date
string | null

The date the invoice was paid

Example:

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

​
memo
string | null

A memo or note on the invoice

Example:

"Payment for services rendered"

​
currency
string | null

The currency of the invoice

Example:

"USD"

​
exchange_rate
string | null

The exchange rate applied to the invoice

Example:

"1.2"

​
total_discount
number | null

The total discount applied to the invoice

Example:

1000

​
sub_total
number | null

The subtotal of the invoice

Example:

10000

​
status
string | null

The status of the invoice

Example:

"Paid"

​
total_tax_amount
number | null

The total tax amount on the invoice

Example:

1000

​
total_amount
number | null

The total amount of the invoice

Example:

11000

​
balance
number | null

The remaining balance on the invoice

Example:

0

​
contact_id
string | null

The UUID of the associated contact

Example:

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

​
accounting_period_id
string | null

The UUID of the associated accounting period

Example:

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

​
tracking_categories
string[] | null

The UUIDs of the tracking categories associated with the invoice

Example:
[
  "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
]
​
line_items
object[]

The line items associated with this invoice

​
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 invoice record

Example:

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

​
remote_id
string | null

The remote ID of the invoice in the context of the 3rd Party

Example:

"invoice_1234"

​
remote_data
object | null

The remote data of the invoice in the context of the 3rd Party

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

The date when the invoice was last updated in the remote system

Example:

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

​
created_at
string | null

The created date of the invoice record

Example:

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

​
modified_at
string | null

The last modified date of the invoice record

Example:

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

Was this page helpful?

Suggest editsRaise issue
Retrieve InvoicesRetrieve Items