List Credit notes ​
Endpoint ​
GET /unified/accounting/credit_notes
Integrations supported
- QuickBooks
- Xero
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
The format of the response.
unified
will return the response with unified mappings applied.raw
will return the raw response from the remote API.normalized
will apply the unified mappings and return the data in a normalized format.
Defaults to unified
.
unified
raw
normalized
unified
By default the result
attribute is an array of objects. This parameter allows you to specify a field in each result
objects to use as key, which transforms the result
array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
id
Ignores the limit
query parameter.
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
This represents the date when the credit note was created
Supported in
- QuickBooks
- Xero
This represents the date when the credit note was updated
Supported in
- QuickBooks
- Xero
The number of the credit note
Supported in
- Xero
The currency of the credit note
Supported in
- Xero
The status of the credit note
authorised
paid
submitted
Supported in
- Xero
Response Body ​
List of Credit notes
The unique identifier for credit notes
Supported in
- QuickBooks
- Xero
The number of the credit note
Supported in
- QuickBooks
- Xero
The status of the credit note
paid
submitted
authorised
Supported in
- Xero
The transaction date of the credit note
Supported in
- QuickBooks
- Xero
The contact of the credit note
Supported in
- QuickBooks
- Xero
The company of the credit note
The total amount of the credit note
Supported in
- QuickBooks
- Xero
The remaining credit of the credit note
Supported in
- QuickBooks
- Xero
The line items of the credit note
Supported in
- QuickBooks
- Xero
The unique identifier for line item
The name of the line item
The description of the line item
The ID of the item
The ID of the account
The quantity of the line item
The unit price of the line item
The ID of the tax rate
The total line amount of the line item.
The type of the line item
Tracking categories of the line item
The ID of the tracking category
The name of the tracking category
The option of the tracking category
The currency of the line item
The exchange rate of the currency for the line item
The currency of the credit note
Supported in
- QuickBooks
- Xero
The payments of the credit note
This represents the date when the credit note was created
Supported in
- QuickBooks
- Xero
This represents the date when the credit note was updated
Supported in
- QuickBooks
- Xero
Raw data returned from the remote API call.
The cursor to use for the next page of results. Pass this value as next_cursor
in the query parameter in the next request to get the next page of results.