GET
/
api
/
credit-notes
/
{id}
{
  "id": 1,
  "creditNoteDate": "2023-01-01T00:00:00Z",
  "creditNoteNumber": "CN-001",
  "referenceNo": "REF-001",
  "customerId": 1,
  "exchangeRate": 1,
  "currencyCode": "USD",
  "note": "Thank you for your business",
  "termsConditions": "Valid for 30 days",
  "isOpen": true,
  "isClosed": false,
  "entries": [
    {
      "index": 1,
      "itemId": 1,
      "rate": 1,
      "quantity": 1,
      "discount": 1,
      "discountType": "percentage",
      "description": "This is a description",
      "taxCode": "123456",
      "taxRateId": 1,
      "warehouseId": 1,
      "projectId": 1,
      "projectRefId": 1,
      "projectRefType": "TASK",
      "projectRefInvoicedAmount": 100,
      "sellAccountId": 1020,
      "costAccountId": 1021
    }
  ],
  "warehouseId": 1,
  "branchId": 1,
  "attachments": [
    {}
  ],
  "discount": 10,
  "discountType": "percentage",
  "adjustment": 5,
  "pdfTemplateId": 1,
  "creditsRemaining": 100,
  "creditsUsed": 50,
  "subtotal": 900,
  "subtotalLocal": 900,
  "discountAmount": 10,
  "discountAmountLocal": 10,
  "discountPercentage": 10,
  "adjustmentLocal": 5,
  "total": 1000,
  "totalLocal": 1000,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "formattedCreditNoteDate": "2023-01-01",
  "formattedCreatedAt": "2023-01-01",
  "formattedAmount": "$1,000.00",
  "formattedCreditsRemaining": "$100.00",
  "formattedCreditsUsed": "$50.00",
  "formattedSubtotal": "$900.00",
  "discountAmountFormatted": "$10.00",
  "discountAmountLocalFormatted": "$10.00",
  "discountPercentageFormatted": "10%",
  "adjustmentFormatted": "$5.00",
  "adjustmentLocalFormatted": "$5.00",
  "totalFormatted": "$1,000.00",
  "totalLocalFormatted": "$1,000.00"
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

Credit note ID

Response

Returns the credit note

​
id
number
required

The unique identifier of the credit note

Example:

1

​
creditNoteDate
string<date-time>
required

The date of the credit note

Example:

"2023-01-01T00:00:00Z"

​
creditNoteNumber
string
required

The credit note number

Example:

"CN-001"

​
customerId
number
required

The ID of the customer

Example:

1

​
isOpen
boolean
required

Whether the credit note is open

Example:

true

​
isClosed
boolean
required

Whether the credit note is closed

Example:

false

​
entries
object[]
required

The line items of the credit note

​
subtotal
number
required

The subtotal amount before discount and adjustments

Example:

900

​
total
number
required

The total amount after discount and adjustments

Example:

1000

​
createdAt
string<date-time>
required

The date when the credit note was created

Example:

"2023-01-01T00:00:00Z"

​
formattedCreditNoteDate
string
required

Formatted credit note date

Example:

"2023-01-01"

​
formattedCreatedAt
string
required

Formatted created at date

Example:

"2023-01-01"

​
formattedAmount
string
required

Formatted amount

Example:

"$1,000.00"

​
formattedCreditsRemaining
string
required

Formatted credits remaining

Example:

"$100.00"

​
formattedCreditsUsed
string
required

Formatted credits used

Example:

"$50.00"

​
formattedSubtotal
string
required

Formatted subtotal

Example:

"$900.00"

​
discountAmountFormatted
string
required

Formatted discount amount

Example:

"$10.00"

​
discountAmountLocalFormatted
string
required

Formatted discount amount in local currency

Example:

"$10.00"

​
discountPercentageFormatted
string
required

Formatted discount percentage

Example:

"10%"

​
adjustmentFormatted
string
required

Formatted adjustment

Example:

"$5.00"

​
adjustmentLocalFormatted
string
required

Formatted adjustment in local currency

Example:

"$5.00"

​
totalFormatted
string
required

Formatted total

Example:

"$1,000.00"

​
totalLocalFormatted
string
required

Formatted total in local currency

Example:

"$1,000.00"

​
referenceNo
string

The reference number

Example:

"REF-001"

​
exchangeRate
number

The exchange rate for currency conversion

Example:

1

​
currencyCode
string

The currency code

Example:

"USD"

​
note
string

Custom note on the credit note

Example:

"Thank you for your business"

​
termsConditions
string

Terms and conditions of the credit note

Example:

"Valid for 30 days"

​
warehouseId
number

The ID of the warehouse

Example:

1

​
branchId
number

The ID of the branch

Example:

1

​
attachments
object[]

The attachments of the credit note

​
discount
number

The discount value

Example:

10

​
discountType
enum<string>

The type of discount (percentage or fixed)

Available options:
percentage,
amount
Example:

"percentage"

​
adjustment
number

The adjustment amount

Example:

5

​
pdfTemplateId
number

The ID of the PDF template

Example:

1

​
creditsRemaining
number

The total amount of credits remaining

Example:

100

​
creditsUsed
number

The total amount of credits used

Example:

50

​
subtotalLocal
number

The subtotal amount in local currency

Example:

900

​
discountAmount
number

The discount amount

Example:

10

​
discountAmountLocal
number

The discount amount in local currency

Example:

10

​
discountPercentage
number

The discount percentage

Example:

10

​
adjustmentLocal
number

The adjustment amount in local currency

Example:

5

​
totalLocal
number

The total amount in local currency

Example:

1000

​
updatedAt
string<date-time>

The date when the credit note was last updated

Example:

"2023-01-02T00:00:00Z"