> ## Documentation Index > Fetch the complete documentation index at: https://developers.getbreezyapp.com/llms.txt > Use this file to discover all available pages before exploring further. # Read one payment > Read only within the company associated with the validated key. ## OpenAPI ````yaml /openapi.json get /payments/{payment_id} openapi: 3.0.3 info: title: Breezy Public Reporting API version: 1.0.0 description: >- Read customers, team members, jobs, visits, assignments, installed equipment, captured form responses, time entries, configured-period timesheets, business reference catalogs, job leads, estimates, invoices, payments, refunds, recorded job financials, saved sold/earned credits, and financial summaries for your company. Existing API keys grant company-wide read access. Amounts are integer USD cents. Reads return current corrected records, with cursor pagination for collecting results. Read the [Breezy FSM guides](https://developers.getbreezyapp.com) for authentication, pagination, refresh limits, and business measures. All reads use latest corrected company records; cursors do not create a snapshot or a complete change feed. servers: - url: https://api.getbreezyapp.com/v1 description: Breezy FSM production API security: - apiKey: [] tags: - name: Company - name: Invoices - name: Payments - name: Refunds - name: Reports - name: TeamMembers - name: Accounts - name: Contacts - name: Locations - name: Jobs - name: JobAppointments - name: JobAssignments - name: BusinessUnits - name: JobTypes - name: JobClasses - name: JobLifecycles - name: LeadSources - name: Tags - name: Estimates - name: JobLeads - name: Equipment - name: FormResponses - name: TimeEntries - name: Timesheets - name: JobFinancials - name: RevenueAttributions externalDocs: description: Breezy FSM reporting guides and API reference url: https://developers.getbreezyapp.com paths: /payments/{payment_id}: get: tags: - Payments summary: Read one payment description: Read only within the company associated with the validated key. operationId: getPayment parameters: - schema: type: string format: uuid required: true name: payment_id in: path responses: '200': description: Successful read. Clients ignore unrecognized response fields. headers: Cache-Control: schema: type: string example: private, no-store content: application/json: schema: $ref: '#/components/schemas/PaymentResponse' example: data: id: 11111111-1111-4111-8111-000000000701 number: P-1001 account: id: 11111111-1111-4111-8111-000000000101 name: Example Household status: PAID method: CARD amount_cents: 80000 currency: USD occurred_at: '2026-09-02T18:00:00Z' created_at: '2026-09-02T18:00:00Z' updated_at: '2026-09-02T18:00:00Z' collected_by: id: 11111111-1111-4111-8111-000000000401 name: Alex Example invoice_allocations: - invoice_id: 11111111-1111-4111-8111-000000000601 applied_cents: 50000 - invoice_id: 11111111-1111-4111-8111-000000000602 applied_cents: 30000 meta: request_id: example-request generated_at: '2026-09-08T19:00:00Z' timezone: America/Los_Angeles '400': description: >- Malformed input, unknown query parameter, unsupported combination or invalid cursor. headers: Cache-Control: schema: type: string example: private, no-store content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: INVALID_REQUEST message: end_date must be later than start_date request_id: example-request details: [] '401': description: Missing, invalid or expired key, or invalid linked identity. headers: Cache-Control: schema: type: string example: private, no-store WWW-Authenticate: schema: type: string example: Bearer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: UNAUTHENTICATED message: A valid API key is required request_id: example-request details: [] '404': description: >- Missing resource or resource outside the authenticated company. Same response for both. headers: Cache-Control: schema: type: string example: private, no-store content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: NOT_FOUND message: Resource not found request_id: example-request details: [] '405': description: Write methods do not mutate business data and return 405. headers: Cache-Control: schema: type: string example: private, no-store Allow: schema: type: string example: GET, HEAD, OPTIONS content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: METHOD_NOT_ALLOWED message: This resource supports GET request_id: example-request details: [] '429': description: Company request budget exhausted; retry after the indicated delay. headers: Cache-Control: schema: type: string example: private, no-store Retry-After: schema: type: integer minimum: 1 description: Seconds before retrying. example: 30 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: RATE_LIMITED message: Request limit exceeded request_id: example-request details: [] '500': description: >- Unexpected failure. Share request_id with support; no stack or provider secrets in response. headers: Cache-Control: schema: type: string example: private, no-store content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: INTERNAL_ERROR message: Unable to complete request request_id: example-request details: [] security: - apiKey: [] components: schemas: PaymentResponse: type: object properties: data: $ref: '#/components/schemas/Payment' meta: $ref: '#/components/schemas/ResponseMeta' required: - data - meta ErrorResponse: type: object properties: error: type: object properties: code: type: string enum: - INVALID_REQUEST - INVALID_CURSOR - UNAUTHENTICATED - NOT_FOUND - METHOD_NOT_ALLOWED - RATE_LIMITED - INTERNAL_ERROR message: type: string request_id: type: string details: type: array items: type: object properties: field: type: string message: type: string required: - field - message required: - code - message - request_id - details required: - error Payment: type: object properties: id: type: string format: uuid number: type: string nullable: true account: $ref: '#/components/schemas/Reference' status: allOf: - $ref: '#/components/schemas/NullablePaymentStatus' - description: >- Null when no status has been recorded; contributes no received amount. method: $ref: '#/components/schemas/PaymentMethod' amount_cents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Integer USD cents; signed where adjustments or balances permit. currency: type: string enum: - USD occurred_at: type: string format: date-time created_at: type: string format: date-time updated_at: type: string nullable: true format: date-time description: >- Recorded parent edit time, null when unavailable; payment status and allocation changes may not advance it. collected_by: $ref: '#/components/schemas/NullableReference' invoice_allocations: type: array items: $ref: '#/components/schemas/PaymentInvoiceAllocation' required: - id - number - account - status - method - amount_cents - currency - occurred_at - created_at - updated_at - collected_by - invoice_allocations description: >- One payment counted once, even if applied to multiple invoices. Occurrence date supports backdating and is not bank settlement. ResponseMeta: type: object properties: request_id: type: string generated_at: type: string format: date-time timezone: type: string required: - request_id - generated_at - timezone description: >- Generation time and company timezone. generated_at is not a snapshot or synchronization token. Reference: type: object properties: id: type: string format: uuid name: type: string required: - id - name NullablePaymentStatus: type: string nullable: true enum: - SUBMITTING - PENDING - PAID - FAILED - CANCELED - PROCESSING - null PaymentMethod: type: string enum: - CARD - ACH - CASH - CHECK - PAYPAL - VENMO - CASHAPP - OTHER - WISETACK_LOAN NullableReference: type: object nullable: true properties: id: type: string format: uuid name: type: string required: - id - name PaymentInvoiceAllocation: type: object properties: invoice_id: type: string format: uuid applied_cents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Integer USD cents; signed where adjustments or balances permit. required: - invoice_id - applied_cents description: >- Identity is (payment ID, invoice_id). Applications need not consume the entire payment. securitySchemes: apiKey: type: http scheme: bearer description: >- Existing Breezy API key. Grants all published reads in its associated company. No app permission scopes. ````