> ## Documentation Index
> Fetch the complete documentation index at: https://docs.curbwaste.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get invoice

> Get invoice.



## OpenAPI

````yaml /openapi/public.openapi.json get /v1/invoices/{id}
openapi: 3.1.0
info:
  title: CurbWaste Public API
  version: 1.0.0
  description: >-
    Partner-facing public API under /v1. Authenticate with a company API key
    (Authorization: Bearer cw_live_…). Outbound webhooks (customer.created /
    customer.updated / location.created / location.updated / pricelist.created)
    use HMAC and are documented separately.
  contact:
    name: CurbWaste
  license:
    name: UNLICENSED 1
servers:
  - url: https://api.curbwaste.com
    description: Production public API
security:
  - ApiKeyBearer: []
tags:
  - name: Customers
    description: >-
      Company CRM customers under /v1/customers. Requires customers:read or
      customers:write.
  - name: Invoices
    description: Company invoices under /v1/invoices. Requires invoices:read.
  - name: Catalog
  - name: Locations
  - name: Zones
paths:
  /v1/invoices/{id}:
    get:
      tags:
        - Invoices
      summary: Get invoice
      description: Get invoice.
      operationId: getInvoice
      parameters:
        - name: id
          in: path
          schema:
            type: string
            format: uuid
          required: true
        - name: expand
          in: query
          schema:
            type: string
          required: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicInvoiceResponse'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    PublicInvoiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PublicInvoice'
      required:
        - data
    PublicInvoice:
      type: object
      properties:
        id:
          type: string
        invoiceNumber:
          oneOf:
            - type: 'null'
            - type: number
        status:
          type: string
        billingQueueStatus:
          oneOf:
            - type: 'null'
            - type: string
        type:
          oneOf:
            - type: 'null'
            - type: string
        currency:
          type: string
        totalAmount:
          type: number
        paidAmount:
          type: number
        balanceDue:
          type: number
        customerId:
          type: string
        invoiceDate:
          oneOf:
            - type: 'null'
            - type: string
        dueDate:
          oneOf:
            - type: 'null'
            - type: string
          description: >-
            ISO due date. Get-by-id matches office: term/timezone-adjusted

            `actualDueDate`. List / billing-queue / open-for-match use the
            stored

            invoice due date (same as office search / billing-queue rows).
        createdAt:
          oneOf:
            - type: 'null'
            - type: string
        updatedAt:
          oneOf:
            - type: 'null'
            - type: string
        totalTax:
          type: number
        paidAt:
          oneOf:
            - type: 'null'
            - type: string
        postedAt:
          oneOf:
            - type: 'null'
            - type: string
          title: 'Matches office MCP get_invoice: sourced from invoice.lockedAt'
          description: 'Matches office MCP get_invoice: sourced from invoice.lockedAt.'
        voidedAt:
          oneOf:
            - type: 'null'
            - type: string
        cancelledAt:
          oneOf:
            - type: 'null'
            - type: string
        voidRemarks:
          oneOf:
            - type: 'null'
            - type: string
        notes:
          oneOf:
            - type: 'null'
            - type: string
        tags:
          type: array
          items:
            type: string
        billingEmail:
          oneOf:
            - type: 'null'
            - type: string
        ccSurchargePercentage:
          oneOf:
            - type: 'null'
            - type: number
        fuelSurchargePercentage:
          oneOf:
            - type: 'null'
            - type: number
        customer:
          $ref: '#/components/schemas/PublicInvoiceCustomer'
        order:
          $ref: '#/components/schemas/PublicInvoiceOrder'
        location:
          $ref: '#/components/schemas/PublicInvoiceLocation'
        items:
          type: array
          items: {}
          title: >-
            Office finalized line-item groups (same payload as office get
            invoice)
          description: >-
            Office finalized line-item groups (same payload as office get
            invoice).
        payments:
          type: array
          items:
            $ref: '#/components/schemas/PublicInvoicePayment'
        creditNotes:
          type: array
          items:
            $ref: '#/components/schemas/PublicInvoiceCreditNote'
        paymentPolicy:
          $ref: '#/components/schemas/PublicInvoicePaymentPolicy'
      required:
        - id
        - invoiceNumber
        - status
        - currency
        - totalAmount
        - paidAmount
        - balanceDue
        - customerId
        - invoiceDate
        - dueDate
        - createdAt
        - updatedAt
    PublicInvoiceCustomer:
      type: object
      properties:
        id:
          type: string
        displayName:
          oneOf:
            - type: 'null'
            - type: string
        customerId:
          oneOf:
            - type: 'null'
            - type: string
        email:
          oneOf:
            - type: 'null'
            - type: string
      required:
        - id
        - displayName
    PublicInvoiceOrder:
      type: object
      properties:
        number:
          oneOf:
            - type: 'null'
            - type: string
        type:
          oneOf:
            - type: 'null'
            - type: string
      required:
        - number
        - type
    PublicInvoiceLocation:
      type: object
      properties:
        name:
          oneOf:
            - type: 'null'
            - type: string
        address:
          oneOf:
            - type: 'null'
            - type: string
        zipcode:
          oneOf:
            - type: 'null'
            - type: string
      required:
        - name
        - address
        - zipcode
    PublicInvoicePayment:
      type: object
      properties:
        id:
          type: string
        reference:
          type: string
        amount:
          type: number
        paymentDate:
          oneOf:
            - type: 'null'
            - type: string
      required:
        - id
        - reference
        - amount
        - paymentDate
    PublicInvoiceCreditNote:
      type: object
      properties:
        id:
          type: string
        description:
          type: string
        currency:
          type: string
        amount:
          type: number
        creditNoteNumber:
          type: string
      required:
        - id
        - description
        - currency
        - amount
    PublicInvoicePaymentPolicy:
      type: object
      properties:
        id:
          type: string
        paymentTerm:
          type: string
        paymentMethod:
          type: string
        paymentMode:
          type: string
        ccSurcharge:
          oneOf:
            - type: 'null'
            - type: number
        fuelSurcharge:
          oneOf:
            - type: 'null'
            - type: number
        customTerm:
          oneOf:
            - type: 'null'
            - type: number
        invoiceDelivery:
          title: Same opaque policy JSON as office GetInvoiceResponse.paymentPolicy
          description: Same opaque policy JSON as office GetInvoiceResponse.paymentPolicy.
      required: []
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Company API key from the developer platform. Header: Authorization:
        Bearer cw_live_…. Key must include customers:read and/or
        customers:write.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.