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

# List retentions



## OpenAPI

````yaml GET /retentions/
openapi: 3.0.3
info:
  title: Piriod API
  version: 1.0.0
  description: >
    Piriod API for billing, payments, procurement and collections.


    All requests require:

    - `Authorization: Token <api_token>` header.

    - `x-simple-workspace: <workspace_id>` header (the account/workspace
    identifier).

    - Optionally `x-piriod-test-mode: true` to operate against test-mode data.


    See the Documentation tab for getting started, integration flows,
    authentication,

    error handling and pagination/filtering guides.
servers:
  - url: https://api.piriod.com
    description: Production
security:
  - TokenAuth: []
paths:
  /retentions/:
    get:
      tags:
        - Procurement
      summary: List retentions
      parameters:
        - $ref: '#/components/parameters/WorkspaceHeader'
        - $ref: '#/components/parameters/TestModeHeader'
        - $ref: '#/components/parameters/PageQuery'
        - $ref: '#/components/parameters/PageSizeQuery'
        - $ref: '#/components/parameters/OrderingQuery'
        - name: supplier
          in: query
          schema:
            type: string
        - name: document
          in: query
          schema:
            type: integer
        - name: number
          in: query
          schema:
            type: integer
        - name: date
          in: query
          schema:
            type: string
            format: date
        - name: total
          in: query
          schema:
            type: number
        - name: bulk
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: Paginated retention list.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Paginated'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/Retention'
components:
  parameters:
    WorkspaceHeader:
      name: x-simple-workspace
      in: header
      required: true
      schema:
        type: string
      description: Workspace (account) identifier. Required for every request.
      example: acc_01H8XYZ123ABC
    TestModeHeader:
      name: x-piriod-test-mode
      in: header
      required: false
      schema:
        type: boolean
        default: false
      description: Whether to operate against test-mode data. Defaults to `false`.
    PageQuery:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number to retrieve (1-indexed).
    PageSizeQuery:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of items per page.
    OrderingQuery:
      name: ordering
      in: query
      required: false
      schema:
        type: string
      description: |
        Field to sort results by. Prefix with `-` for descending order
        (e.g. `-created`).
  schemas:
    Paginated:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          description: Total number of items matching the filter.
          example: 142
        next:
          type: string
          format: uri
          nullable: true
          description: URL of the next page, or `null` if last page.
        previous:
          type: string
          format: uri
          nullable: true
          description: URL of the previous page, or `null` if first page.
        results:
          type: array
          items: {}
          description: The items in the current page.
    Retention:
      type: object
      description: Withholding-tax document issued against a supplier.
      properties:
        id:
          type: integer
          readOnly: true
        supplier:
          type: string
          description: Supplier ID.
        document:
          type: integer
          description: Retention document type.
        number:
          type: integer
        date:
          type: string
          format: date
        amount:
          type: number
          nullable: true
        exempt:
          type: number
          nullable: true
        tax:
          type: number
          nullable: true
        tax_percent:
          type: number
          nullable: true
        subtotal:
          type: number
          nullable: true
        total:
          type: number
          nullable: true
        discount:
          type: number
          nullable: true
        discount_scheme:
          type: string
          enum:
            - '%'
            - $
          nullable: true
        status:
          type: string
          enum:
            - draft
            - finalized
            - cancelled
          readOnly: true
        biller_status:
          type: string
          readOnly: true
        tax_agency:
          type: object
          readOnly: true
        local_file:
          type: string
          format: uri
          readOnly: true
          nullable: true
        imported:
          type: boolean
          readOnly: true
        test_mode:
          type: boolean
          readOnly: true
        lines:
          type: array
          items:
            $ref: '#/components/schemas/RetentionLine'
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
      required:
        - supplier
        - document
        - number
        - date
        - lines
    RetentionLine:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 80
        description:
          type: string
          maxLength: 200
          nullable: true
        amount:
          type: number
        quantity:
          type: number
        exempt:
          type: boolean
          default: false
        tax:
          type: number
          nullable: true
        tax_percent:
          type: number
          nullable: true
        total:
          type: number
          readOnly: true
        discount:
          type: number
          nullable: true
        discount_scheme:
          type: string
          enum:
            - '%'
            - $
          nullable: true
      required:
        - name
        - amount
        - quantity
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Use header `Authorization: Token <api_token>`.
        API tokens are obtained from the Piriod dashboard.

````