Appearance

Create Credit notes ​

Endpoint ​

http
POST /unified/accounting/credit_notes
Integrations supported
  • QuickBooks

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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
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

Request Body ​

Refer Writing data using Unified APIs

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for credit notes

Supported in
  • QuickBooks
number
string

The number of the credit note

Supported in
  • QuickBooks
status
string

The status of the credit note

All possible enum values:
  • paid
  • submitted
  • authorised
  • voided
transaction_date
string · date-time

The transaction date of the credit note

Supported in
  • QuickBooks
contact
string

The contact of the credit note

References: Contacts → id
Supported in
  • QuickBooks
company
string

The company of the credit note

References: CompanyInfo → id
total_amount
number

The total amount of the credit note

Supported in
  • QuickBooks
remaining_credit
number

The remaining credit of the credit note

Supported in
  • QuickBooks
line_items
object[]

The line items of the credit note

Supported in
  • QuickBooks
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
payments
string[]

The payments of the credit note

References: Payments → id
created_at
string · date-time

This represents the date when the credit note was created

Supported in
  • QuickBooks
updated_at
string · date-time

This represents the date when the credit note was updated

Supported in
  • QuickBooks
tracking_categories
object[]

Tracking categories of the credit notes

References: TrackingCategories → id
id
string

The ID of the tracking category

name
string

The name of the tracking category

option
string

The option of the tracking category

remote_data
object

Raw data returned from the remote API call.