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

# Get Cash Settlement

> Returns a cash settlement associated with the authenticated driver.



## OpenAPI

````yaml /api-reference/driver/openapi.json get /api/v1/driver/cash-settlements/{cashSettlementId}
openapi: 3.0.0
info:
  title: DEVMOB Driver API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Auth
    description: Authentication and token lifecycle
  - name: Cash Settlement
    description: Automatic cash accountability and cooperative confirmation.
  - name: Checkout
    description: QR checkout sessions
  - name: Invite
    description: Driver invitation preview and acceptance
  - name: Notification
    description: Driver inbox notifications
  - name: OTP
    description: One-time password flows
  - name: Profile
    description: Authenticated driver profile
  - name: Session
    description: Authenticated sessions
  - name: Storage
    description: Storage uploads
  - name: Trip
    description: Driver trips
  - name: Trip Boarding
    description: Ticket boarding
  - name: Trip Event
    description: Trip operational events
  - name: Trip Manifest
    description: Trip passenger manifest
  - name: Trip Tracking
    description: Driver GPS tracking
paths:
  /api/v1/driver/cash-settlements/{cashSettlementId}:
    get:
      tags:
        - Cash Settlement
      summary: Get Cash Settlement
      description: Returns a cash settlement associated with the authenticated driver.
      operationId: getDriverCashSettlement
      parameters:
        - name: cashSettlementId
          required: true
          in: path
          description: Cash settlement identifier
          schema:
            type: string
            format: uuid
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashSettlement'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearer: []
components:
  schemas:
    CashSettlement:
      type: object
      description: >-
        Automatically submitted accountability record for one CASH checkout
        session.
      properties:
        cashSettlementId:
          type: string
          format: uuid
          description: Cash settlement identifier.
        checkoutSessionId:
          type: string
          format: uuid
          description: Unique checkout session that originated the settlement.
        paymentId:
          type: string
          format: uuid
          nullable: true
          description: Payment linked after cooperative confirmation.
        organizationId:
          type: string
          format: uuid
          description: Cooperative organization identifier.
        cooperativeId:
          type: string
          format: uuid
          description: Cooperative responsible for confirmation.
        transportOperatorId:
          type: string
          format: uuid
          description: Transport operator from the trip context.
        driverId:
          type: string
          format: uuid
          description: Driver responsible for the cash sale.
        declaredAmount:
          type: integer
          minimum: 0
          description: Amount automatically declared in cents.
        status:
          type: string
          enum:
            - PENDING
            - CONFIRMED
            - REJECTED
          description: Cash settlement status.
        submittedBy:
          type: string
          format: uuid
          description: User that confirmed the checkout session.
        submittedAt:
          type: string
          format: date-time
          description: Automatic submission date.
        confirmedBy:
          type: string
          format: uuid
          nullable: true
          description: OPS user that confirmed the settlement.
        confirmedAt:
          type: string
          format: date-time
          nullable: true
          description: Cooperative confirmation date.
        rejectedBy:
          type: string
          format: uuid
          nullable: true
          description: OPS user that rejected the settlement.
        rejectedAt:
          type: string
          format: date-time
          nullable: true
          description: Cooperative rejection date.
        rejectionReason:
          type: string
          nullable: true
          description: Reason informed when the settlement is rejected.
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: User that created the record.
        createdAt:
          type: string
          format: date-time
          description: Creation date.
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: User that last updated the record.
        updatedAt:
          type: string
          format: date-time
          description: Last update date.
      required:
        - cashSettlementId
        - checkoutSessionId
        - paymentId
        - organizationId
        - cooperativeId
        - transportOperatorId
        - driverId
        - declaredAmount
        - status
        - submittedBy
        - submittedAt
        - confirmedBy
        - confirmedAt
        - rejectedBy
        - rejectedAt
        - rejectionReason
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
    ValidationError:
      type: object
      properties:
        statusCode:
          type: integer
          description: HTTP status code.
          example: 400
        message:
          type: string
          description: Error message.
          example: Bad Request Error
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Validation code.
                example: invalid_type
              message:
                type: string
                description: Validation message.
                example: Required
              path:
                type: string
                description: Invalid field path.
                example: name
            required:
              - code
              - message
              - path
      required:
        - statusCode
        - message
        - errors
      description: Validation error response.
    ApiError:
      type: object
      properties:
        statusCode:
          type: integer
          description: HTTP status code.
          example: 404
        error:
          type: string
          description: HTTP error name.
          example: Not Found
        message:
          type: string
          description: Machine-readable error code.
          example: resource.not_found
      required:
        - statusCode
        - error
        - message
      description: Domain error response.
  responses:
    BadRequestError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
    UnauthorizedError:
      description: Authentication required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ForbiddenError:
      description: Forbidden.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFoundError:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````