Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
accounting/vendorcredits

Retrieve Vendor Credits

Retrieve Vendor Credits from any connected Accounting software

get/accounting/vendorcredits/{id}

Path parameters

idstring required

id of the vendorcredit 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

numberstring nullable

The number of the vendor credit

transaction_datestring date-time nullable

The date of the transaction

vendorstring nullable

The UUID of the vendor associated with the credit

total_amountstring nullable

The total amount of the vendor credit

currencystring nullable

The currency of the vendor credit

exchange_ratestring nullable

The exchange rate applied to the vendor credit

company_idstring nullable

The UUID of the associated company

tracking_categoriesstring[] nullable

The UUID of the tracking categories associated with the vendor credit

accounting_period_idstring nullable

The UUID of the associated accounting period

field_mappingsobject nullable

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

idstring nullable

The UUID of the vendor credit record

remote_idstring nullable

The remote ID of the vendor credit

created_atstring date-time

The created date of the vendor credit

modified_atstring date-time

The last modified date of the vendor credit

remote_updated_atstring date-time nullable

The date when the vendor credit was last updated in the remote system

remote_dataobject nullable

The remote data of the vendor credit in the context of the 3rd Party

Example response

{
  "number": "VC-001",
  "transaction_date": "2024-06-15T12:00:00Z",
  "vendor": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "total_amount": "1000",
  "currency": "USD",
  "exchange_rate": "1.2",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "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": "remote_id_1234",
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  }
}