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

# Get voucher types

> Get the voucher types available on your debt collection partner, sorted by their order. Fetch the list once and cache it rather than hard-coding the ids — it also covers the types your partner has defined themselves, which are not on the [Voucher types](/api-reference/voucher-types) page.

**Required scope:** `read:voucher-types`



## OpenAPI

````yaml GET /v1/{tenantId}/voucher-types
openapi: 3.1.0
info:
  title: Debbie Creditor API Docs
  description: >-
    The Debbie Creditor API is a RESTful interface allowing you, as a creditor,
    to programmatically send data to your debt collection partner and access
    your data in the platform. It provides predictable URLs for accessing
    resources, and uses built-in HTTP features to receive commands and return
    responses. This makes it easy to integrate with your own systems, for
    example your ERP or invoicing system.
  version: v1.0.0
  x-logo:
    url: https://debbie-platform.github.io/creditor-api-docs/deb-logo.svg
servers:
  - url: https://api.debbiecollect.com
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Endpoints for interacting with customers
  - name: Files
    description: Endpoints for interacting with files
  - name: Documents
    description: Endpoints for attaching documentation to a case or to your creditor
  - name: Direct payments
    description: Endpoints for registering payments made directly to you
  - name: Voucher types
    description: >-
      Endpoints for reading the voucher types available on your debt collection
      partner
  - name: Billings
    description: Endpoints for reading how a settlement is made up
externalDocs:
  description: Find out more about Debbie here
  url: https://debbiecollect.com
paths:
  /v1/{tenantId}/voucher-types:
    get:
      tags:
        - Voucher types
      summary: Get voucher types
      description: >-
        Get the voucher types available on your debt collection partner, sorted
        by their order. Fetch the list once and cache it rather than hard-coding
        the ids — it also covers the types your partner has defined themselves,
        which are not on the [Voucher types](/api-reference/voucher-types) page.


        **Required scope:** `read:voucher-types`
      operationId: get-voucher-types
      parameters:
        - in: path
          name: tenantId
          schema:
            type: string
            format: uuid
          required: true
          description: >-
            Id of your debt collection partner's tenant. You can find it on the
            API page in the creditor portal.
        - in: query
          name: page
          schema:
            type: integer
          example: 0
          description: Page to get. Starting from 0.
        - in: query
          name: pageSize
          schema:
            type: integer
            maximum: 500
          example: 25
          description: Number of items per page.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      currentPage:
                        type: integer
                        example: 0
                      pageSize:
                        type: integer
                        example: 25
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VoucherType'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
components:
  schemas:
    VoucherType:
      type: object
      properties:
        voucherTypeId:
          type: string
          format: uuid
          description: Id of the voucher type
          examples:
            - 7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d
        label:
          type: string
          description: Display name of the voucher type
          examples:
            - Deposit
        category:
          type: string
          enum:
            - disbursement
            - fee
            - collectioncommission
            - payout
            - overpayment
            - vat
            - transaction
            - cost
            - courtcost
            - interest
            - principal
          description: Category of the voucher type
          examples:
            - transaction
        public:
          type: boolean
          description: >-
            Whether the voucher type is one of the built-in public types shared
            by every tenant, as opposed to a tenant-specific type
          examples:
            - true
        order:
          type: integer
          description: Sort order of the voucher type. The list is sorted by this value.
          examples:
            - 10
        vat:
          type: boolean
          description: Whether vouchers of this type carry VAT
          examples:
            - false
        setting:
          type:
            - string
            - 'null'
          enum:
            - INTEREST_PERCENTAGE
            - INTEREST_FROM_TABLE
            - COMPOUND_INTEREST
            - FIXED_INTEREST
            - AMOUNT_FROM_TABLE
            - TEXT_AS_LABEL
            - null
          description: >-
            Behavior of vouchers of this type, e.g. how interest is calculated.
            Null when the type has no special behavior.
          examples:
            - null
        settingDetails:
          type:
            - object
            - 'null'
          description: >-
            Configuration of the behavior selected in setting. Its shape depends
            on the setting. Null when the type has no special behavior.
        editorSettings:
          type:
            - object
            - 'null'
          description: Settings for how vouchers of this type are edited in the Debbie apps
  responses:
    UnauthorizedError:
      description: Access token missing or invalid
    UnprocessableContent:
      description: Unable to process the contained instructions.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authentication with an API key can be done by using a bearer token in
        the Authorization header. This is done using the following format
        `Authorization: Bearer {token}`. API keys are issued and revoked
        directly from the creditor portal under Developers > API.

````