Get credit note
The Get credit note endpoint returns a single credit note for a given creditNoteId.
Credit notes are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
Before using this endpoint, you must have retrieved data for the company.
Response
Success
Identifier for the credit note, unique to the company in the accounting software.
Friendly reference for the credit note.
Total amount of credit that has been applied to the customer's accounts receivable
Any discounts applied to the credit note amount.
Value of the credit note, including discounts and excluding tax.
Additional tax amount applied to credit note.
Percentage rate of any additional tax applied to the credit note.
Any tax applied to the credit note amount.
Percentage rate (from 0 to 100) of discounts applied to the credit note.
Unused balance of totalAmount originally raised.
In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
2020-10-08T22:40:50Z
2021-01-01T00:00:00
When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
- Unqualified local time: 2021-11-15T01:00:00
- UTC time offsets: 2021-11-15T01:00:00-05:00
Time zones
Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
2020-10-08T22:40:50Z
2021-01-01T00:00:00
When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
- Unqualified local time: 2021-11-15T01:00:00
- UTC time offsets: 2021-11-15T01:00:00-05:00
Time zones
Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
An array of payment allocations.
Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer.
The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.
Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.
This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).
In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.
The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.
It is not populated (read more) when:
- Pulling attachments
- The accounting software does not provide modification dates for a data type
- A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
- A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records
In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.