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

# Get Reimbursement

> Get a reimbursement's details.



## OpenAPI

````yaml /openapi/workforce-management.yaml get /v1/reimbursements/{reimbursementId}
openapi: 3.0.0
info:
  description: APIs for interacting with Cadana Payroll Platform
  version: 1.0.0
  title: Business Workforce Management
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Custom Auth
    description: APIs for interacting with Custom Authentication
  - name: Persons
    description: APIs for interacting with the HR module
  - name: Milestones
    description: APIs for milestone-based contractor pay
  - name: Instant Pay
    description: APIs for interacting with Instant Pay functionality
  - name: Users
    description: APIs for interacting with employee/contractor Cadana accounts
  - name: Files
    description: APIs for interacting with file uploads
  - name: Payrolls
    description: APIs for interacting with Payroll
  - name: Platform
    description: Platform APIs for interacting with businesses
  - name: Businesses
    description: APIs for interacting with Business
  - name: Treasury
    description: APIs for business balances, funding, and withdrawals
  - name: KYB
    description: APIs for business verification
  - name: Contracts
    description: APIs for interacting with contracts
  - name: Sandbox
    description: APIs for relevant sandbox simulations
  - name: Invoices
    description: APIs for interacting with invoices
  - name: Reimbursements
    description: APIs for interacting with reimbursements
  - name: Entities
    description: >-
      APIs for managing legal sub-entities (subsidiaries, branches) under a
      parent business
paths:
  /v1/reimbursements/{reimbursementId}:
    get:
      tags:
        - Reimbursements
      summary: Get Reimbursement
      description: Get a reimbursement's details.
      operationId: getReimbursement
      parameters:
        - $ref: '#/components/parameters/reimbursementId'
        - $ref: '#/components/parameters/XMultiTenantKey'
        - name: potentialSourceCurrency
          in: query
          required: false
          description: >-
            Return a `potentialSourceAmount` quote — the estimated amount that
            would be debited from a wallet of this currency to fund the
            reimbursement, at current FX rates. Only computed while the
            reimbursement is not yet approved or paid.
          schema:
            type: string
      responses:
        '200':
          description: The reimbursement
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  userId:
                    type: string
                    format: uuid
                  title:
                    type: string
                  fullName:
                    type: string
                  currency:
                    type: string
                  destinationCurrency:
                    type: string
                  status:
                    type: string
                  entries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        description:
                          type: string
                        amount:
                          type: object
                          properties:
                            currency:
                              type: string
                            value:
                              type: string
                        category:
                          type: string
                        date:
                          type: string
                  sourceAmount:
                    type: object
                    properties:
                      currency:
                        type: string
                      value:
                        type: string
                  destinationAmount:
                    type: object
                    properties:
                      currency:
                        type: string
                      value:
                        type: string
                  potentialSourceAmount:
                    type: object
                    description: >-
                      Estimated amount that would be debited from a
                      `potentialSourceCurrency` wallet to fund this
                      reimbursement, at current FX rates. Only returned when the
                      `potentialSourceCurrency` query parameter is supplied and
                      the reimbursement is not yet approved or paid.
                    properties:
                      currency:
                        type: string
                      value:
                        type: string
                  fxRate:
                    type: object
                    description: >-
                      Conversion rates applied when the source and destination
                      currencies differ, keyed by `FROM-TO` currency pair.
                      Absent when no conversion was needed.
                    additionalProperties:
                      type: string
                  createdTimestamp:
                    type: integer
                  lastUpdatedTimestamp:
                    type: integer
              example:
                id: d1e2f3a4-5678-9012-cdef-345678901234
                userId: a3b4c5d6-e7f8-9012-abcd-ef3456789012
                title: Client dinner
                fullName: Ada Lovelace
                currency: USD
                destinationCurrency: USD
                status: Approved
                entries:
                  - id: e1f2a3b4-5678-9012-cdef-345678901234
                    description: Dinner with client
                    amount:
                      currency: USD
                      value: '1000.00'
                    category: Meals
                    date: '2025-11-28'
                sourceAmount:
                  currency: GHS
                  value: '15420.00'
                destinationAmount:
                  currency: USD
                  value: '1000.00'
                fxRate:
                  USD-GHS: '15.42'
                createdTimestamp: 1764332528
                lastUpdatedTimestamp: 1764332600
        '404':
          $ref: '#/components/responses/NotFoundError'
        5XX:
          $ref: '#/components/responses/InternalError'
      security:
        - Authorization: []
components:
  parameters:
    reimbursementId:
      name: reimbursementId
      in: path
      description: The unique identifier for the reimbursement
      required: true
      schema:
        type: string
        format: uuid
    XMultiTenantKey:
      name: X-MultiTenantKey
      in: header
      required: false
      schema:
        type: string
      description: >-
        Required when using a Platform API token. The tenant key identifying
        which business to operate on.
  responses:
    NotFoundError:
      description: Requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
    InternalError:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
  schemas:
    NotFoundError:
      description: Not Found
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: resource_not_found
        message: Requested resource could not be found.
    InternalError:
      description: Internal server error
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: internal_error
        message: An unexpected error occurred. Please try again later.
    Error:
      type: object
      properties:
        code:
          description: A machine parsable error code
          type: string
          enum:
            - invalid_request_body
            - resource_not_found
            - forbidden
            - internal_error
        message:
          description: A human readable message describing the error
          type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````