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

Changes

Changed in 5 of the 18 revisions of this API.186

    • ○

      removed the AED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the AFN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ALL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the AMD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ANG enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the AOA enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ARS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the AUD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the AWG enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the AZN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BAM enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BBD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BDT enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BGN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BHD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BIF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BMD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BND enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BOB enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BRL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BSD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BTN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BWP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BYN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BZD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CAD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CDF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CHF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CLP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CNY enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the COP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CRC enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CUP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CVE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CZK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the DJF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the DKK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the DOP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the DZD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the EGP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ERN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ETB enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the EUR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the FJD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the FKP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the FOK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GBP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GEL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GGP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GHS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GIP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GMD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GNF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GTQ enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the GYD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HKD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HNL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HRK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HTG enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HUF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IDR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ILS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IMP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IQD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IRR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ISK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the JEP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the JMD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the JOD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the JPY enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KES enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KGS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KHR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KID enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KMF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KRW enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KWD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KYD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the KZT enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the LAK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the LBP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the LKR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the LRD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the LSL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the LYD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MDL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MGA enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MKD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MMK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MNT enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MOP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MRU enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MUR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MVR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MWK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MXN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MYR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MZN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NAD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NGN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NIO enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NOK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NPR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NZD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the OMR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PAB enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PEN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PGK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PHP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PKR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PLN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PYG enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the QAR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the RON enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the RSD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the RUB enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the RWF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SAR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SBD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SCR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SDG enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SEK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SGD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SHP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SLE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SLL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SOS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SRD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SSP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the STN enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SYP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SZL enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the THB enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TJS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TMT enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TND enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TOP enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRY enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TTD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TVD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TWD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TZS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UAH enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UGX enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the USD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UYU enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UZS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the VES enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the VND enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the VUV enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the WST enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the XAF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the XCD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the XDR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the XOF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the XPF enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the YER enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ZAR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ZMW enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ZWL enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the endpoint scheme security bearer was added to the API

      api-security-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed