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

# Get a payment request

> Requires the `payment_requests:read` scope (קריאת דרישות תשלום).



## OpenAPI

````yaml /api-reference/openapi.json get /v1/payment-requests/{id}
openapi: 3.1.0
info:
  title: Lancer API
  version: 1.0.0
  description: >-
    The Lancer public REST API. Authenticate with an organization API key
    (Settings → API & Webhooks) as `Authorization: Bearer lk_…` or `X-Api-Key`.
    Every key has scopes; each operation names the one it needs. Money is
    integer agorot (1 ₪ = 100). Lists are paginated with `page` and `pageSize`
    (max 100).
  contact:
    name: Lancer
    url: https://docs.lancer-erp.com
servers:
  - url: https://api.lancer-erp.com/api
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Leads
    description: >-
      Push leads into the sales pipeline from website forms, ad platforms, n8n
      or Make.
  - name: Clients
    description: Read and create clients (the businesses and people you bill).
  - name: Projects
    description: Read projects, their status and billing.
  - name: Payment requests
    description: Read and create payment requests, optionally with a hosted pay link.
  - name: Payments
    description: Read payments received.
paths:
  /v1/payment-requests/{id}:
    get:
      tags:
        - Payment requests
      summary: Get a payment request
      description: Requires the `payment_requests:read` scope (קריאת דרישות תשלום).
      operationId: getVPaymentRequestsId
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  clientId:
                    type: string
                    minLength: 1
                  projectId:
                    anyOf:
                      - type: string
                        minLength: 1
                      - type: 'null'
                  title:
                    type: string
                  amountAgorot:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  paidAgorot:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  creditedAgorot:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  dueDate:
                    anyOf:
                      - type: string
                        pattern: ^\d{4}-\d{2}-\d{2}$
                      - type: 'null'
                  status:
                    type: string
                    enum:
                      - not_sent
                      - sent
                      - partially_paid
                      - paid
                      - overdue
                      - cancelled
                  sentAt:
                    type:
                      - string
                      - 'null'
                  payUrl:
                    type:
                      - string
                      - 'null'
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                required:
                  - id
                  - clientId
                  - projectId
                  - title
                  - amountAgorot
                  - paidAgorot
                  - creditedAgorot
                  - dueDate
                  - status
                  - sentAt
                  - payUrl
                  - createdAt
                  - updatedAt
                additionalProperties: false
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '401':
          description: Missing, unknown or revoked API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: The key lacks the scope (code INSUFFICIENT_SCOPE)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found in this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: lk_…
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key

````

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