v18

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

accounting/creditnotes

Retrieve Credit Notes

Retrieve Credit Notes from any connected Accounting software

get/accounting/creditnotes/{id}

Path parameters

idstring required

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

transaction_datestring date-time nullable

The date of the credit note transaction

statusstring nullable

The status of the credit note

numberstring nullable

The number of the credit note

contact_idstring nullable

The UUID of the associated contact

company_idstring nullable

The UUID of the associated company

exchange_ratestring nullable

The exchange rate applied to the credit note

total_amountnumber nullable

The total amount of the credit note

remaining_creditnumber nullable

The remaining credit on the credit note

tracking_categoriesstring[] nullable

The UUIDs of the tracking categories associated with the credit note

currencystring nullable

The currency of the credit note

paymentsstring[] nullable

The payments associated with the credit note

applied_paymentsstring[] nullable

The applied payments associated with the credit note

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 credit note record

remote_idstring nullable

The remote ID of the credit note in the context of the 3rd Party

remote_dataobject nullable

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

remote_created_atstring date-time nullable

The date when the credit note was created in the remote system

remote_updated_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the credit note record

modified_atstring date-time nullable

The last modified date of the credit note record

Example response

{
  "transaction_date": "2024-06-15T12:00:00Z",
  "status": "Issued",
  "number": "CN-001",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "exchange_rate": "1.2",
  "total_amount": 10000,
  "remaining_credit": 5000,
  "tracking_categories": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "currency": "USD",
  "payments": [
    "PAYMENT-001",
    "PAYMENT-002"
  ],
  "applied_payments": [
    "APPLIED-001",
    "APPLIED-002"
  ],
  "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "creditnote_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-06-15T12:00:00Z",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z"
}