Get a credit note

curl --request GET \
  --url https://www.ruddr.io/api/workspace/credit-notes/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "2f4a8c1e-9b37-4d62-ae15-7c830f2e5d91",
  "companyName": "Palermo Consulting, LLC",
  "companyStreetAddress": "1500 North Main Boulevard\nBuilding 500, Suite 250B\nAtlanta, GA 30338",
  "number": "CN-0042",
  "statusId": "applied",
  "billTo": "Paul's Boutique\n99 Ludlow Street\nNew York, New York  10002",
  "creditNoteFor": "Invoice for Consulting Engagement",
  "issuedOn": "2026-01-28",
  "poNumber": "PO-20260128",
  "notes": "Credit issued for overbilled hours in Q4 2025.",
  "emailSubject": "Credit Note CN-0042 from Palermo Consulting",
  "emails": [
    "billing@paulsboutique.com"
  ],
  "ccEmails": [
    "ar@palermoconsulting.com"
  ],
  "emailBody": "Hi,\n\nA credit note from Palermo Consulting has been prepared for your review.\n\nThank you for your business!\n\nRegards,\nPalermo Consulting",
  "emailFromName": "Palermo Consulting",
  "replyTo": "invoices@palermoconsulting.com",
  "sendBcc": true,
  "sentOn": "2026-01-29",
  "currency": "USD",
  "subtotal": 4025,
  "taxRate": 0.0775,
  "totalTax": 0,
  "total": 4025,
  "appliedCredit": 4025,
  "remainingCredit": 0,
  "createdAt": "2026-01-28T20:57:40.194Z",
  "client": {
    "id": "aa39afdb-e168-4956-b061-41c7c62e8c2e",
    "name": "Paul's Boutique"
  },
  "lines": [
    {
      "id": "b6be8459-e8c3-4893-aa66-f5df1bfe3f9c",
      "lineNumber": 1,
      "item": "Consulting Services",
      "description": "Reporting - Q4 2025",
      "quantity": 18,
      "rate": 175,
      "amount": 3150,
      "taxable": false,
      "invoiceItem": {
        "id": "aba04832-216c-463e-8998-c520948f707c",
        "name": "Consulting Services"
      },
      "project": {
        "id": "1687c3a8-bc9b-43ed-b80c-69e485315c22",
        "name": "Consulting Engagement"
      }
    }
  ],
  "projects": [
    {
      "id": "1687c3a8-bc9b-43ed-b80c-69e485315c22",
      "name": "Consulting Engagement"
    }
  ],
  "invoices": [
    {
      "id": "d3e92f7a-15c4-48b1-9037-6e4f2a8b5c10",
      "number": "INV-0117",
      "amount": 4025
    }
  ]
}

GET

credit-notes

{id}

Get a credit note

curl --request GET \
  --url https://www.ruddr.io/api/workspace/credit-notes/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "2f4a8c1e-9b37-4d62-ae15-7c830f2e5d91",
  "companyName": "Palermo Consulting, LLC",
  "companyStreetAddress": "1500 North Main Boulevard\nBuilding 500, Suite 250B\nAtlanta, GA 30338",
  "number": "CN-0042",
  "statusId": "applied",
  "billTo": "Paul's Boutique\n99 Ludlow Street\nNew York, New York  10002",
  "creditNoteFor": "Invoice for Consulting Engagement",
  "issuedOn": "2026-01-28",
  "poNumber": "PO-20260128",
  "notes": "Credit issued for overbilled hours in Q4 2025.",
  "emailSubject": "Credit Note CN-0042 from Palermo Consulting",
  "emails": [
    "billing@paulsboutique.com"
  ],
  "ccEmails": [
    "ar@palermoconsulting.com"
  ],
  "emailBody": "Hi,\n\nA credit note from Palermo Consulting has been prepared for your review.\n\nThank you for your business!\n\nRegards,\nPalermo Consulting",
  "emailFromName": "Palermo Consulting",
  "replyTo": "invoices@palermoconsulting.com",
  "sendBcc": true,
  "sentOn": "2026-01-29",
  "currency": "USD",
  "subtotal": 4025,
  "taxRate": 0.0775,
  "totalTax": 0,
  "total": 4025,
  "appliedCredit": 4025,
  "remainingCredit": 0,
  "createdAt": "2026-01-28T20:57:40.194Z",
  "client": {
    "id": "aa39afdb-e168-4956-b061-41c7c62e8c2e",
    "name": "Paul's Boutique"
  },
  "lines": [
    {
      "id": "b6be8459-e8c3-4893-aa66-f5df1bfe3f9c",
      "lineNumber": 1,
      "item": "Consulting Services",
      "description": "Reporting - Q4 2025",
      "quantity": 18,
      "rate": 175,
      "amount": 3150,
      "taxable": false,
      "invoiceItem": {
        "id": "aba04832-216c-463e-8998-c520948f707c",
        "name": "Consulting Services"
      },
      "project": {
        "id": "1687c3a8-bc9b-43ed-b80c-69e485315c22",
        "name": "Consulting Engagement"
      }
    }
  ],
  "projects": [
    {
      "id": "1687c3a8-bc9b-43ed-b80c-69e485315c22",
      "name": "Consulting Engagement"
    }
  ],
  "invoices": [
    {
      "id": "d3e92f7a-15c4-48b1-9037-6e4f2a8b5c10",
      "number": "INV-0117",
      "amount": 4025
    }
  ]
}

A document issued to reduce the amount owed by a client on a previous invoice.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The credit note uuid

Response

200

string

The unique identifier for the object.

companyName

string | null

The company name printed on the credit note.

companyStreetAddress

string | null

The company street address printed on the credit note.

number

string

The credit note number (e.g. CN-0042).

statusId

string

The status of the credit note. One of draft, open, or applied.

billTo

string

The billing address or recipient text printed on the credit note.

creditNoteFor

string | null

A brief description of what the credit note is for.

issuedOn

string<date>

The date the credit note was issued (ISO 8601 date).

poNumber

string | null

The purchase order number associated with the credit note.

notes

string | null

Internal or external notes on the credit note.

emailSubject

string | null

The email subject used when sending the credit note.

emails

string[]

The list of recipient email addresses.

ccEmails

string[]

The list of CC email addresses.

emailBody

string | null

The email body used when sending the credit note.

emailFromName

string | null

The sender display name used when sending the credit note.

replyTo

string | null

The reply-to email address used when sending the credit note.

sendBcc

boolean

Whether the workspace is BCC'd when the credit note is sent.

sentOn

string<date> | null

The date the credit note was sent (ISO 8601 date), or null if not yet sent.

currency

string

The ISO 4217 currency code for the credit note (e.g. USD).

subtotal

number

The sum of all line item amounts before tax.

taxRate

number

The tax rate applied to taxable line items, expressed as a decimal (e.g. 0.0775 for 7.75%).

totalTax

number

The total tax amount calculated from taxable line items.

total

number

The total amount of the credit note including tax.

appliedCredit

number

The total amount of credit that has been applied to invoices or payments.

remainingCredit

number

The remaining unapplied credit balance.

createdAt

string<date-time>

The timestamp when the object was created.

client

object

The client the credit note belongs to.

Show child attributes

lines

object[]

The line items on the credit note.

Show child attributes

projects

object[]

The projects associated with this credit note.

Show child attributes

invoices

object[]

The invoices this credit note has been applied to.

Show child attributes

List credit notes List payments

⌘I

Projects

Time

Pipeline

Expenses

Resourcing

Billing

Workspace

Members

Custom Data

Get a credit note

Authorizations

Path Parameters

Response