> ## Documentation Index > Fetch the complete documentation index at: https://docs.ruddr.io/llms.txt > Use this file to discover all available pages before exploring further. # List credit notes A document issued to reduce the amount owed by a client on a previous invoice. ## OpenAPI ````yaml openapi.json GET /credit-notes openapi: 3.1.0 info: title: Ruddr API version: '1.0' license: name: Proprietary url: https://www.ruddr.com/master-subscription-agreement servers: - url: https://www.ruddr.io/api/workspace security: - bearerAuth: [] tags: - name: Allocations description: Manage resource allocations for scheduling team members to projects. - name: Availability Periods description: Manage member availability periods for capacity planning. - name: Business Units description: >- Manage business units for organizing invoice settings and grouping clients and projects. - name: Client Roles description: Manage client roles and their billing terms. - name: Client Tags description: Manage tags for categorizing clients. - name: Clients description: Manage clients and their billing settings. - name: Companies description: Manage companies in the CRM pipeline. - name: Company Spend Tiers description: Manage spend tier classifications for companies. - name: Company Types description: Manage type classifications for companies. - name: Contact Tags description: Manage tags for categorizing contacts. - name: Contacts description: Manage contacts associated with clients, companies, and opportunities. - name: Cost Periods description: Manage member cost rate periods for profitability tracking. - name: Credit Notes description: View credit notes issued against invoices. - name: Disciplines description: Manage disciplines for classifying member skill areas. - name: Exchange Rate description: Get exchange rates for multi-currency workspaces. - name: Exchange Rate Periods description: Manage custom exchange rate periods for currency conversion. - name: Expense Categories description: Manage expense categories for tracking and reporting. - name: Expense Items description: Manage individual expense line items. - name: Expense Reports description: Manage expense reports submitted by members. - name: Holiday Schedules description: Manage holiday schedules for capacity and availability planning. - name: Holidays description: Manage individual holidays within holiday schedules. - name: Industries description: Manage industry classifications for clients and companies. - name: Invoice Items description: Manage invoice line item types for billing. - name: Invoices description: View invoices and their line items. - name: Job Titles description: Manage job title classifications for members. - name: Locations description: Manage office locations for members and projects. - name: Member Certifications description: Manage certification types that can be assigned to members. - name: Member Levels description: Manage member level classifications for career tracking. - name: Member Tags description: Manage tags for categorizing members. - name: Members description: Manage workspace members and their profiles. - name: Opportunities description: Manage sales opportunities in the CRM pipeline. - name: Opportunity Pipelines description: Manage pipelines for tracking opportunity stages. - name: Opportunity Lead Sources description: Manage lead source classifications for opportunities. - name: Opportunity Stages description: Manage pipeline stage definitions for opportunities. - name: Opportunity Tags description: Manage tags for categorizing opportunities. - name: Opportunity Types description: Manage type classifications for opportunities. - name: Payment Methods description: Manage payment method options for invoices. - name: Payments description: View payments received against invoices. - name: Pipeline Activities description: >- Manage pipeline activities associated with companies, contacts, members, and opportunities. - name: Pipeline Activity Types description: Manage activity type classifications for pipeline activities. - name: Practices description: Manage practice area classifications for organizing projects and members. - name: Project Budget Expenses description: Manage expense budget line items on projects. - name: Project Budget Other Items description: Manage other budget line items on projects. - name: Project Budget Product Items description: Manage product budget line items on projects. - name: Project Budget Service Items description: Manage additional service budget line items on projects. - name: Project Expenses description: Manage project-level expense line items. - name: Project Groups description: View project groups for organizing related projects. - name: Project Health Reports description: Manage project health status reports. - name: Project Invoice Milestones description: Manage invoice milestones for fixed-fee project billing. - name: Project Members description: Manage team member assignments on projects. - name: Project Monthly Budget Expenses description: Manage monthly expense budget line items on projects. - name: Project Monthly Budget Other Items description: Manage monthly other budget line items on projects. - name: Project Monthly Budget Product Items description: Manage monthly product budget line items on projects. - name: Project Monthly Budget Service Items description: Manage monthly additional service budget line items on projects. - name: Project Other Items description: Manage project-level other item line items. - name: Project Product Items description: Manage project-level product line items. - name: Project Revenue Adjustments description: Manage earned revenue adjustments for projects. - name: Project Revenue Recognition Entries description: Manage revenue recognition entries for projects. - name: Project Roles description: Manage roles defined on projects for billing and staffing. - name: Project Service Items description: Manage project-level additional service line items. - name: Project Tags description: Manage tags for categorizing projects. - name: Project Tasks description: Manage tasks on projects for time tracking and planning. - name: Project Types description: Manage type classifications for projects. - name: Projects description: Manage projects and their settings. - name: Resource Placeholders description: Manage placeholder resources for allocation planning. - name: Security Roles description: View security roles for assigning member permissions. - name: Skills description: Manage skill classifications for members and resource planning. - name: Task Categories description: Manage task category classifications for project tasks. - name: Task Tags description: Manage tags for categorizing project tasks. - name: Task Templates description: Manage reusable task templates for projects. - name: Tax Rates description: Manage tax rates for invoicing. - name: Time Entries description: Manage time entries for tracking hours on projects. - name: Time Off Types description: Manage time off type classifications. - name: Timesheet Attestations description: Manage attestation statements members sign when submitting timesheets. - name: Timesheets description: Manage timesheet submissions for tracking hours across a period. - name: Utilization Target Periods description: Manage member utilization target periods for capacity planning. - name: Workspace Roles description: Manage workspace-level roles for billing rate configuration. paths: /credit-notes: get: tags: - Credit Notes summary: List credit notes operationId: list-credit-notes parameters: - $ref: '#/components/parameters/StartingAfter' - $ref: '#/components/parameters/EndingBefore' - $ref: '#/components/parameters/Limit' - name: clientId in: query description: >- A client ID (`uuid`) used to filter credit notes for a specific client. schema: type: string responses: '200': description: '200' content: application/json: schema: type: object properties: results: type: array description: The list of results for the current page. items: $ref: '#/components/schemas/CreditNote' hasMore: type: boolean description: Whether there are more results available after this page. examples: Result: value: results: - id: 2f4a8c1e-9b37-4d62-ae15-7c830f2e5d91 companyName: Palermo Consulting, LLC companyStreetAddress: |- 1500 North Main Boulevard Building 500, Suite 250B Atlanta, GA 30338 number: CN-0042 statusId: applied billTo: |- Paul's Boutique 99 Ludlow Street New 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, A credit note from Palermo Consulting has been prepared for your review. Thank you for your business! Regards, Palermo 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 projects: - id: 1687c3a8-bc9b-43ed-b80c-69e485315c22 name: Consulting Engagement 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 invoices: - id: d3e92f7a-15c4-48b1-9037-6e4f2a8b5c10 number: INV-0117 amount: 4025 hasMore: false '400': description: '400' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: InvalidId: value: status: 400 message: Parameter 'clientId' is not a valid UUID. deprecated: false components: parameters: StartingAfter: name: startingAfter in: query description: >- A cursor ID (`uuid`) used to request the next page of results. If not provided, defaults to the first page of results. schema: type: string EndingBefore: name: endingBefore in: query description: >- A cursor ID (`uuid`) used to request the previous page of results. Is mutually exclusive with `startingAfter`. schema: type: string Limit: name: limit in: query description: >- The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided. schema: type: integer schemas: CreditNote: type: object properties: id: type: string description: The unique identifier for the object. companyName: type: - string - 'null' description: The company name printed on the credit note. companyStreetAddress: type: - string - 'null' description: The company street address printed on the credit note. number: type: string description: The credit note number (e.g. `CN-0042`). statusId: type: string description: The current status of the credit note. enum: - draft - open - applied billTo: type: string description: The billing address or recipient text printed on the credit note. creditNoteFor: type: - string - 'null' description: A brief description of what the credit note is for. issuedOn: type: string format: date description: The date the credit note was issued (`YYYY-MM-DD`). poNumber: type: - string - 'null' description: The purchase order number associated with the credit note. notes: type: - string - 'null' description: Internal or external notes on the credit note. emailSubject: type: - string - 'null' description: The email subject used when sending the credit note. emails: type: array description: The list of recipient email addresses. items: type: string ccEmails: type: array description: The list of CC email addresses. items: type: string emailBody: type: - string - 'null' description: The email body used when sending the credit note. emailFromName: type: - string - 'null' description: The sender display name used when sending the credit note. replyTo: type: - string - 'null' description: The reply-to email address used when sending the credit note. sendBcc: type: boolean description: Whether the workspace is BCC'd when the credit note is sent. sentOn: type: - string - 'null' format: date description: The date the credit note was sent (`YYYY-MM-DD`). currency: type: string description: The ISO 4217 currency code for the credit note (e.g. `USD`). subtotal: type: number description: The sum of all line item amounts before tax. taxRate: type: number description: >- The tax rate applied to taxable line items, expressed as a decimal (e.g. `0.0775` for 7.75%). totalTax: type: number description: The total tax amount calculated from taxable line items. total: type: number description: The total amount of the credit note including tax. appliedCredit: type: number description: >- The total amount of credit that has been applied to invoices or payments. remainingCredit: type: number description: The remaining unapplied credit balance. createdAt: type: string format: date-time description: The timestamp when the object was created. client: type: object description: The client the credit note belongs to. properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the client. projects: type: array description: The projects associated with this credit note. items: type: object properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the project. lines: type: array description: The line items on the credit note. items: type: object properties: id: type: string description: The unique identifier for the object. lineNumber: type: integer description: The display order of the line item. item: type: - string - 'null' description: >- The name of the line item. For draft credit notes, this is derived from the associated invoice item name. description: type: - string - 'null' description: The description for the line item. quantity: type: - number - 'null' description: The quantity for the line item. rate: type: - number - 'null' description: The unit rate for the line item. amount: type: - number - 'null' description: The total amount for the line item (quantity × rate). taxable: type: boolean description: Whether the line item is subject to tax. invoiceItem: type: - object - 'null' description: The invoice item category for this line item. properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the invoice item. project: type: - object - 'null' description: The project associated with this line item. properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the project. invoices: type: array description: The invoices this credit note has been applied to. items: type: object properties: id: type: string description: The unique identifier for the object. number: type: string description: The invoice number. amount: type: number description: The amount of credit applied to this invoice. ErrorResponse: type: object properties: status: type: integer description: The HTTP status code. message: type: string description: A human-readable error message. securitySchemes: bearerAuth: type: http scheme: bearer ````