Conduyt Invoices API

openapi: 3.2.0
info:
  title: Conduyt Invoices API
  version: 1.0.0
  description: 'The Conduyt CRM API provides programmatic access to your CRM data including

    contacts, companies, deals, pipelines, tasks, notes, automations, invoices,

    email sequences, and more.


    ## Authentication


    All authenticated endpoints require a Bearer token (API key) in the

    `Authorization` header:


    ```

    Authorization: Bearer cdy_

    ```


    API keys are generated in **Settings > API Keys** within the Conduyt

    dashboard. Keys use the `cdy_` prefix and are hashed with bcrypt on

    creation — the full key is shown exactly once at creation time.


    Session cookie authentication (`conduyt_session`) is also supported for

    browser-based clients but is not recommended for integrations.


    ## Rate Limiting


    API keys enforce a per-key rate limit. New keys default to 100 requests per

    minute and can be configured at creation time or with PATCH `/api-keys/{id}`.

    Some public and provider-facing endpoints also enforce stricter per-IP or

    per-account limits. When exceeded, the API returns `429 Too Many Requests`

    with a `Retry-After` header indicating seconds until the next allowed

    request.


    | Endpoint Group | Limit |

    |---------------------|---------------------|

    | API keys | Default 100 / min per key |

    | Login/reset | 5 / min per IP |

    | Registration | 3 / hour per IP |

    | Contact/Deal create | 30 / min per IP |

    | Inbound messages | 120 / min per account/IP |


    ## Pagination


    List endpoints support cursor-based pagination via query parameters:


    - `page` — Page number (default: 1)

    - `per_page` — Items per page (default: 50, max: 200)

    - `limit` — Accepted as an alias of `per_page` on `GET /contacts`; if both are

    sent they must carry the same value.


    A page size above the maximum, a non-integer, a value below 1, or a

    pagination key repeated with different values is rejected with `400`

    (the message names the parameter and the rule); nothing is silently

    clamped or ignored.


    Responses include a `meta` object: `{ page, per_page, total }`.


    An operation that documents its own pagination rules follows those instead.

    `GET /sms-providers/options` pages with an opaque `cursor` and a `limit`

    that is capped at 50 rather than rejected; its responses carry

    `meta: { nextCursor, truncated }`.


    ## Response Format


    All successful responses wrap data in a `data` envelope:

    ```json

    { "data": { ... } }

    ```


    Error responses use:

    ```json

    { "error": "Human-readable error message" }

    ```


    ## Multi-Tenancy


    Conduyt is multi-tenant. All data is scoped to the authenticated user''s

    current account. API keys are bound to a specific account at creation time.


    ## Webhook Events


    Outbound webhooks fire on events including:

    `contact.created`, `contact.updated`, `contact.deleted`,

    `deal.created`, `deal.updated`, `deal.won`, `deal.lost`,

    `task.created`, `task.completed`, `note.created`,

    `appointment.created`, `appointment.updated`,

    `form.submitted`, `invoice.paid`


    Payloads are signed with HMAC-SHA256 using the webhook''s secret. Retry

    schedule: 1m, 5m, 30m, 2h, 12h, 72h (7 total attempts including the initial delivery).'
  contact:
    name: Conduyt Support
    url: https://conduyt.app
    email: support@conduyt.app
  license:
    name: Proprietary
    url: https://conduyt.app/terms
servers:
- url: https://conduyt.app/api/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: Invoices
  description: Invoice creation, sending, payments, PDF generation
paths:
  /invoices:
    get:
      operationId: listInvoices
      summary: List invoices
      tags:
      - Invoices
      parameters:
      - name: contact_id
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: date_from
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: date_to
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
          default: 1
          minimum: 1
        x-default-provenance: handler_literal
      - name: per_page
        in: query
        required: false
        description: Items per page (max 200)
        schema:
          type: integer
          default: 50
          minimum: 1
          maximum: 200
        x-default-provenance: handler_literal
      - name: search
        in: query
        required: false
        description: Full-text search query
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      responses:
        '200':
          description: Paginated invoices
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data: {}
                      meta: {}
                    required:
                    - data
                    - meta
                required:
                - data
    post:
      operationId: createInvoice
      summary: Create an invoice
      tags:
      - Invoices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceCreate'
      responses:
        '201':
          description: Invoice created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
      parameters:
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
  /invoices/next-number:
    get:
      operationId: getNextInvoiceNumber
      summary: Get the next auto-incremented invoice number
      tags:
      - Invoices
      responses:
        '200':
          description: Next invoice number
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      invoiceNumber: {}
                    required:
                    - invoiceNumber
                required:
                - data
      parameters: []
  /invoices/{id}:
    get:
      operationId: getInvoice
      summary: Get an invoice by ID
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Invoice details with line items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateInvoice
      summary: Update an invoice
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Invoice updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                companyId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                contactId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                currency:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                dealId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                dueDate:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      description:
                        description: Read by the handler from the JSON body (the route declares no schema for its type).
                      productId:
                        description: Read by the handler from the JSON body (the route declares no schema for its type).
                      quantity:
                        description: Read by the handler from the JSON body (the route declares no schema for its type).
                      sortOrder:
                        description: Read by the handler from the JSON body (the route declares no schema for its type).
                      unitPrice:
                        description: Read by the handler from the JSON body (the route declares no schema for its type).
                    description: Read by the handler from the JSON body (the route declares no schema for its type).
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                notes:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                taxRate:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                terms:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
    delete:
      operationId: deleteInvoice
      summary: Delete an invoice
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Invoice deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id: {}
                      deleted:
                        type: boolean
                    required:
                    - id
                    - deleted
                required:
                - data
  /invoices/{id}/send:
    post:
      operationId: sendInvoice
      summary: Send an invoice via email
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Invoice sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
  /invoices/{id}/void:
    post:
      operationId: voidInvoice
      summary: Void an invoice
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Invoice voided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
  /invoices/{id}/pdf:
    get:
      operationId: getInvoicePdf
      summary: Download invoice as PDF
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: download
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: boolean
      responses:
        '200':
          description: PDF file
          content:
            application/pdf:
              schema:
                type: string
                format: binary
  /invoices/{id}/payment-link:
    post:
      operationId: createInvoicePaymentLink
      summary: Create a Stripe payment link for an invoice
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Payment link URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      url: {}
                    required:
                    - url
                required:
                - data
  /invoices/{id}/payments:
    get:
      operationId: listInvoicePayments
      summary: List payments for an invoice
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Payments for this invoice
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data: {}
                    required:
                    - data
                required:
                - data
    post:
      operationId: recordInvoicePayment
      summary: Record a manual payment against an invoice
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - amount
              properties:
                amount:
                  type: number
                  format: double
                method:
                  type: string
                  default: card
                reference:
                  type: string
                notes:
                  type: string
                paidAt:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '201':
          description: Payment recorded
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      invoice: {}
                    required:
                    - invoice
                required:
                - data
  /invoices/{id}/overpayments/{overpaymentId}/manual-refund:
    post:
      x-generated: true
      operationId: postInvoicesIdOverpaymentsOverpaymentIdManualRefund
      summary: Create / invoke invoices id overpayments overpaymentId manual-refund
      tags:
      - Invoices
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: overpaymentId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                stripeRefundId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      already_refunded: {}
                    required:
                    - already_refunded
                required:
                - data
  /invoices/{id}/overpayments/{overpaymentId}/refund:
    post:
      x-generated: true
      operationId: postInvoicesIdOverpaymentsOverpaymentIdRefund
      summary: Create / invoke invoices id overpayments overpaymentId refund
      tags:
      - Invoices
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: overpaymentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      already_refunded: {}
                    required:
                    - already_refunded
                required:
                - data
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      already_refunded:
                        type: boolean
                      processing:
                        type: boolean
                    required:
                    - already_refunded
                    - processing
                required:
                - data
components:
  schemas:
    InvoiceCreate:
      type: object
      required:
      - items
      properties:
        invoiceNumber:
          type: string
          minLength: 1
          maxLength: 200
          description: Optional; generated when omitted. 1 to 200 characters.
        contactId:
          type: string
          format: uuid
        companyId:
          type: string
          format: uuid
        dealId:
          type: string
          format: uuid
        dueDate:
          type: string
          format: date-time
        taxRate:
          type: number
          format: double
        currency:
          type: string
          default: USD
        notes:
          type: string
        terms:
          type: string
        items:
          type: array
          minItems: 1
          items:
            type: object
            required:
            - description
            - quantity
            - unitPrice
            properties:
              productId:
                type: string
                format: uuid
              description:
                type: string
              quantity:
                type: number
              unitPrice:
                type: number
              sortOrder:
                description: Read by the handler from the JSON body (the route declares no schema for its type).
    DataEnvelope:
      type: object
      properties:
        data:
          description: Response payload (shape varies by endpoint)
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable error code (e.g., TRIAL_EXPIRED, PLAN_LIMIT_REACHED)
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Resource UUID
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API key authentication. Generate keys in Settings > API Keys.

        Keys use the `cdy_` prefix.


        Example: `Authorization: Bearer cdy_a1b2c3d4e5f6...`

        '
x-mcp:
  transport:
  - stdio
  - http
  orchestration: code
  endpoint_tools: hidden