v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

accounting/invoices

Retrieve Invoices

Retrieve Invoices from any connected Accounting software

get/accounting/invoices/{id}

Path parameters

idstring required

id of the invoice you want to retrieve.

Query parameters

remote_databoolean

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

Headers

x-connection-tokenstring required

The connection token

Response

typestring nullable

The type of the invoice

numberstring nullable

The invoice number

issue_datestring date-time nullable

The date the invoice was issued

due_datestring date-time nullable

The due date of the invoice

paid_on_datestring date-time nullable

The date the invoice was paid

memostring nullable

A memo or note on the invoice

currencystring nullable

The currency of the invoice

exchange_ratestring nullable

The exchange rate applied to the invoice

total_discountnumber nullable

The total discount applied to the invoice

sub_totalnumber nullable

The subtotal of the invoice

statusstring nullable

The status of the invoice

total_tax_amountnumber nullable

The total tax amount on the invoice

total_amountnumber nullable

The total amount of the invoice

balancenumber nullable

The remaining balance on the invoice

contact_idstring nullable

The UUID of the associated contact

accounting_period_idstring nullable

The UUID of the associated accounting period

tracking_categoriesstring[] nullable

The UUIDs of the tracking categories associated with the invoice

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the invoice record

remote_idstring nullable

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

remote_dataobject nullable

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

remote_updated_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the invoice record

modified_atstring date-time nullable

The last modified date of the invoice record

Example response

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