invoicepdfs-com

invoicepdfs-com Payments API

The payments API from invoicepdfs-com — 2 operation(s) for payments.

GitHub OpenAPI

Operations 5

GET /api/v1/documents/{document_id}/payments List Document Payments #
POST /api/v1/documents/{document_id}/payments Create Document Payment #
GET /api/v1/payments/{payment_id} Get Payment #
PATCH /api/v1/payments/{payment_id} Update Payment #
DELETE /api/v1/payments/{payment_id} Delete Payment #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/invoicepdfs-com/openapi/invoicepdfs-com-payments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-document-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-document-patch-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-business-profile-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-recurring-invoice-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-document-render-options-schema.json
📊
JSONSchema
https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-customer-create-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/invoicepdfs-com:invoicepdfs-com-payments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

invoicepdfs-com-payments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Invoicepdfs Com Payments API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged payments across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Payments
paths:
  /api/v1/documents/{document_id}/payments:
    get:
      tags:
      - Payments
      summary: List Document Payments
      description: Payments recorded against one document, newest first.
      operationId: list_document_payments
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    post:
      tags:
      - Payments
      summary: Create Document Payment
      description: 'Record a payment received against an invoice.


        The currency is taken from the invoice rather than from the request, so a

        payment can never disagree with what was billed.


        Refused with 409 while the invoice is still a draft. Recording a payment

        does not move the invoice to `paid` — use `mark_paid` for that.'
      operationId: create_document_payment
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/payments/{payment_id}:
    get:
      tags:
      - Payments
      summary: Get Payment
      description: One recorded payment by id.
      operationId: get_payment
      security:
      - HTTPBearer: []
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
          title: Payment Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    patch:
      tags:
      - Payments
      summary: Update Payment
      description: 'Correct a payment that was already recorded.


        Only the fields you send are changed. The invoice''s status and totals are

        left alone.'
      operationId: update_payment
      security:
      - HTTPBearer: []
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
          title: Payment Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentPatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    delete:
      tags:
      - Payments
      summary: Delete Payment
      description: 'Remove a recorded payment.


        The payment is deleted outright rather than reversed, and the invoice''s

        status is left alone. The deletion is kept in the audit log.'
      operationId: delete_payment
      security:
      - HTTPBearer: []
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
          title: Payment Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleBoolResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    PaymentResponse:
      properties:
        data:
          $ref: '#/components/schemas/PaymentOut'
      type: object
      required:
      - data
      title: PaymentResponse
    PaymentPatchRequest:
      properties:
        amount:
          type: string
          title: Amount
        paid_at:
          type: string
          format: date-time
          title: Paid At
        method:
          anyOf:
          - type: string
          - type: 'null'
          title: Method
        reference:
          anyOf:
          - type: string
          - type: 'null'
          title: Reference
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
      type: object
      title: PaymentPatchRequest
    PaymentOut:
      properties:
        id:
          type: string
          title: Id
        invoice_id:
          type: string
          title: Invoice Id
        amount:
          $ref: '#/components/schemas/MoneyOut'
        paid_at:
          type: string
          title: Paid At
        method:
          anyOf:
          - type: string
          - type: 'null'
          title: Method
        reference:
          anyOf:
          - type: string
          - type: 'null'
          title: Reference
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - invoice_id
      - amount
      - paid_at
      - created_at
      - updated_at
      title: PaymentOut
    MoneyOut:
      properties:
        amount:
          type: string
          title: Amount
        currency:
          type: string
          title: Currency
      type: object
      required:
      - amount
      - currency
      title: MoneyOut
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    PaymentsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PaymentOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: PaymentsListResponse
    SimpleBoolResponse:
      properties:
        data:
          additionalProperties:
            type: boolean
          type: object
          title: Data
      type: object
      required:
      - data
      title: SimpleBoolResponse
      description: 'Generic boolean response envelope.


        Example:

        {"data": {"deleted": true}}'
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    PaymentCreateRequest:
      properties:
        amount:
          type: string
          title: Amount
          examples:
          - '53.10'
        paid_at:
          type: string
          format: date-time
          title: Paid At
          examples:
          - '2026-07-17T18:30:00Z'
        method:
          anyOf:
          - type: string
          - type: 'null'
          title: Method
          examples:
          - bank_transfer
        reference:
          anyOf:
          - type: string
          - type: 'null'
          title: Reference
          examples:
          - BANK-REF-10291
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
      type: object
      required:
      - amount
      - paid_at
      title: PaymentCreateRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs