> ## 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.

# Get an invoice

A document sent to request payment for goods or services.


## OpenAPI

````yaml openapi.json GET /invoices/{id}
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:
  /invoices/{id}:
    get:
      tags:
        - Invoices
      summary: Get an invoice
      operationId: get-an-invoice
      parameters:
        - name: id
          in: path
          description: The invoice `uuid`
          schema:
            type: string
          required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invoice'
              examples:
                Result:
                  value:
                    id: 56deca22-a707-4148-a5f7-ea3ae6391d67
                    companyName: Ruddr Inc.
                    companyStreetAddress: 123 Main St, Suite 200
                    number: INV-001
                    statusId: paid
                    billTo: Acme Corp
                    invoiceFor: Website Redesign - January 2025
                    issuedOn: '2025-01-15'
                    servicesThrough: '2025-01-31'
                    dueOn: '2025-02-14'
                    poNumber: PO-84657
                    notes: Payment due within 30 days.
                    emailSubject: Invoice INV-001 from Ruddr Inc.
                    emails:
                      - billing@acmecorp.com
                    ccEmails:
                      - finance@acmecorp.com
                    emailBody: Please find your invoice attached.
                    emailFromName: Ruddr Billing
                    replyTo: billing@ruddr.io
                    sendBcc: true
                    sentOn: '2025-01-15'
                    currency: USD
                    subtotal: 50000
                    totalDiscount: 2500
                    taxRate: 0.05
                    totalTax: 2375
                    total: 49875
                    amountPaid: 49875
                    amountCredited: 500
                    amountDue: 0
                    createdAt: '2025-01-15T20:47:03.284Z'
                    client:
                      id: 7c8f2e19-4d5a-4a3b-9c6d-2e8f1a0b3c4d
                      name: Acme Corp
                    projects:
                      - id: b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0
                        name: Website Redesign
                    lines:
                      - id: f1105e03-a6ab-4e9c-9e62-71d699067477
                        lineNumber: 1
                        item: Design Services
                        description: Homepage and landing page design
                        quantity: 40
                        rate: 150
                        amount: 6000
                        taxable: true
                        invoiceItem:
                          id: d4e5f6a7-b8c9-0123-4567-89abcdef0123
                          name: Design Services
                        project:
                          id: b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0
                          name: Website Redesign
                    payments:
                      - id: e5f6a7b8-c9d0-1234-5678-9abcdef01234
                        referenceNumber: CHK-1234
                        amount: 49875
                    creditNotes:
                      - id: f6a7b8c9-d0e1-2345-6789-abcdef012345
                        number: CN-001
                        amount: 500
                    paymentTerm:
                      id: 3a2b1c0d-4e5f-6789-0abc-def123456789
                      name: Net 30
                      type: net
                      days: 30
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidId:
                  value:
                    status: 400
                    message: Parameter 'id' is not a valid UUID.
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                NotFound:
                  value:
                    status: 404
                    message: >-
                      Object with id 'a1f4e8dc-9b72-4c6a-8e3d-5f0b2a7c9d4e' not
                      found.
      deprecated: false
components:
  schemas:
    Invoice:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the object.
        companyName:
          type:
            - string
            - 'null'
          description: The company name displayed on the invoice.
        companyStreetAddress:
          type:
            - string
            - 'null'
          description: The company street address displayed on the invoice.
        number:
          type: string
          description: The invoice number.
        statusId:
          type: string
          description: The current status of the invoice.
          enum:
            - draft
            - open
            - sent
            - viewed
            - partially_paid
            - paid
            - overdue
            - void
            - write_off
        billTo:
          type:
            - string
            - 'null'
          description: The bill-to text displayed on the invoice.
        invoiceFor:
          type:
            - string
            - 'null'
          description: A description of the products or services being invoiced.
        issuedOn:
          type:
            - string
            - 'null'
          format: date
          description: The date the invoice was issued (`YYYY-MM-DD`).
        servicesThrough:
          type:
            - string
            - 'null'
          format: date
          description: The services-through date (`YYYY-MM-DD`).
        dueOn:
          type:
            - string
            - 'null'
          format: date
          description: The date the invoice is due (`YYYY-MM-DD`).
        poNumber:
          type:
            - string
            - 'null'
          description: The purchase order number.
        notes:
          type:
            - string
            - 'null'
          description: Notes displayed on the invoice.
        emailSubject:
          type:
            - string
            - 'null'
          description: The email subject used when sending the invoice.
        emails:
          type: array
          items:
            type: string
          description: The email addresses the invoice is sent to.
        ccEmails:
          type: array
          items:
            type: string
          description: The CC email addresses when sending the invoice.
        emailBody:
          type:
            - string
            - 'null'
          description: The email body used when sending the invoice.
        emailFromName:
          type:
            - string
            - 'null'
          description: The from name used when sending the invoice.
        replyTo:
          type:
            - string
            - 'null'
          description: The reply-to email address used when sending the invoice.
        sendBcc:
          type: boolean
          description: Whether to send a BCC copy when the invoice is sent.
        sentOn:
          type:
            - string
            - 'null'
          format: date
          description: The date the invoice was sent (`YYYY-MM-DD`).
        currency:
          type: string
          description: The 3-letter currency code for the invoice.
        subtotal:
          type: number
          description: The subtotal of all line items before discounts and taxes.
        totalDiscount:
          type:
            - number
            - 'null'
          description: The total discount amount applied to the invoice.
        taxRate:
          type: number
          description: The tax rate as a decimal (e.g., 0.05 for 5%).
        totalTax:
          type: number
          description: The total tax amount on the invoice.
        total:
          type: number
          description: The total amount of the invoice including tax.
        amountPaid:
          type: number
          description: The total amount paid on the invoice.
        amountCredited:
          type: number
          description: The total amount credited on the invoice.
        amountDue:
          type: number
          description: The remaining balance due on the invoice.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the object was created.
        client:
          type: object
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the client.
          description: The client associated with this invoice.
        projects:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The unique identifier for the object.
              name:
                type: string
                description: The name of the project.
          description: The projects associated with this invoice.
        lines:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The unique identifier for the object.
              lineNumber:
                type: integer
                description: The line number.
              item:
                type:
                  - string
                  - 'null'
                description: >-
                  The line item name. For draft invoices, this is derived from
                  the invoice item name.
              description:
                type:
                  - string
                  - 'null'
                description: The line item description.
              quantity:
                type:
                  - number
                  - 'null'
                description: The quantity for the line item.
              rate:
                type:
                  - number
                  - 'null'
                description: The rate for the line item.
              amount:
                type: number
                description: The total amount for the line item.
              taxable:
                type: boolean
                description: Whether the line item is taxable.
              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.
          description: The line items on the invoice.
        payments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The unique identifier for the object.
              referenceNumber:
                type:
                  - string
                  - 'null'
                description: The payment reference number.
              amount:
                type: number
                description: The payment amount applied to this invoice.
          description: Payments applied to this invoice.
        creditNotes:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The unique identifier for the object.
              number:
                type: string
                description: The credit note number.
              amount:
                type: number
                description: The credit note amount applied to this invoice.
          description: Credit notes applied to this invoice.
        paymentTerm:
          type:
            - object
            - 'null'
          description: The payment term for the invoice.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the payment term.
            type:
              type: string
              description: The payment term type (e.g., "net", "eom").
            days:
              type: integer
              description: The number of days for the payment term.
    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

````