Appearance

List Credit notes ​

Endpoint ​

http
GET /unified/accounting/credit_notes
Integrations supported
  • QuickBooks
  • Xero

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

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.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
created_at
string · date-time

This represents the date when the credit note was created

Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the credit note was updated

Supported in
  • QuickBooks
  • Xero
number
string

The number of the credit note

Supported in
  • Xero
currency
string

The currency of the credit note

Supported in
  • Xero
status
string

The status of the credit note

All possible enum values:
  • authorised
  • paid
  • submitted
Supported in
  • Xero

Response Body ​

result
object[]

List of Credit notes

id
string
REQUIRED · 

The unique identifier for credit notes

Supported in
  • QuickBooks
  • Xero
number
string

The number of the credit note

Supported in
  • QuickBooks
  • Xero
status
string

The status of the credit note

All possible enum values:
  • paid
  • submitted
  • authorised
Supported in
  • Xero
transaction_date
string · date-time

The transaction date of the credit note

Supported in
  • QuickBooks
  • Xero
contact
string

The contact of the credit note

Supported in
  • QuickBooks
  • Xero
company
string

The company of the credit note

total_amount
number

The total amount of the credit note

Supported in
  • QuickBooks
  • Xero
remaining_credit
number

The remaining credit of the credit note

Supported in
  • QuickBooks
  • Xero
line_items
object[]

The line items of the credit note

Supported in
  • QuickBooks
  • Xero
id
string

The unique identifier for line item

name
string

The name of the line item

description
string

The description of the line item

item
string

The ID of the item

account
string

The ID of the account

quantity
number

The quantity of the line item

unit_price
number

The unit price of the line item

tax_rate
string

The ID of the tax rate

total_line_amount
number

The total line amount of the line item.

type
string

The type of the line item

tracking_categories
object[]

Tracking categories of the line item

id
string

The ID of the tracking category

name
string

The name of the tracking category

option
string

The option of the tracking category

currency
string

The currency of the line item

exchange_rate
number

The exchange rate of the currency for the line item

currency
string

The currency of the credit note

Supported in
  • QuickBooks
  • Xero
payments
string[]

The payments of the credit note

created_at
string · date-time

This represents the date when the credit note was created

Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the credit note was updated

Supported in
  • QuickBooks
  • Xero
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.