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

# Get administration declaration uploads

> Get administration declaration uploads



## OpenAPI

````yaml /openapi3.json get /v1/health_care/declaration_uploads
openapi: 3.0.0
info:
  title: API Endpoints
  description: >-
    This page allows you to explore the available API endpoints. Select a
    resource (e.g. debtors) and an endpoint (e.g. /v1/debtors) to inspect an
    example response and available parameters. An authorization header
    containing a Bearer token is required, see
    [Authentication](/authentication/authorization).
  version: 1.0.0
servers:
  - url: https://api.paytsoftware.com
    description: Production
  - url: https://demo-api.paytsoftware.com
    description: Demo / testing
security:
  - bearerAuth: []
tags:
  - name: administrations
    description: Operations about administrations
  - name: companies
    description: Operations about companies
  - name: contacts
    description: Operations about contacts
  - name: credit_cases
    description: Operations about credit_cases
  - name: debtors
    description: Operations about debtors
  - name: files
    description: Operations about files
  - name: health_care
    description: Operations about health_cares
  - name: orders
    description: Operations about orders
  - name: order_lines
    description: Operations about order_lines
  - name: invoices
    description: Operations about invoices
  - name: labels
    description: Operations about labels
  - name: ledger_accounts
    description: Operations about ledger_accounts
  - name: messages
    description: Operations about messages
  - name: notes
    description: Operations about notes
  - name: notifications
    description: Operations about notifications
  - name: payments
    description: Operations about payments
  - name: payment_conditions
    description: Operations about payment_conditions
  - name: payment_plans
    description: Operations about payment_plans
  - name: psp_mandates
    description: Operations about psp_mandates
  - name: psp_transactions
    description: Operations about psp_transactions
  - name: sign_up
    description: Operations about sign_ups
  - name: tasks
    description: Operations about tasks
  - name: vat_rates
    description: Operations about vat_rates
paths:
  /v1/health_care/declaration_uploads:
    get:
      tags:
        - health_care
      summary: Get administration declaration uploads
      description: Get administration declaration uploads
      operationId: getV1HealthCareDeclarationUploads
      parameters:
        - in: query
          name: administration_id
          description: Administration identifier
          required: true
          schema:
            type: string
        - in: query
          name: ids
          description: Filter declaration uploads with a comma separated list of ids
          required: false
          schema:
            type: string
        - in: query
          name: fields
          description: >-
            JSON object defining fields to receive (e.g {"only": ["field1",
            {"field2": ["field3"]}]})
          required: false
          schema:
            type: string
        - in: query
          name: cursor
          description: The record identifier after which to start the page
          required: false
          schema:
            type: string
        - in: query
          name: per_page
          description: >-
            How many records will be returned per page, (1..500), defaults to
            100
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 500
            default: 100
      responses:
        '200':
          description: Paginated list of declaration uploads
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerApi_DeclarationUploadsPageEntity'
        '401':
          description: Not authenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerApi_ErrorEntity'
        '403':
          description: Access not authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerApi_ErrorEntity'
components:
  schemas:
    CustomerApi_DeclarationUploadsPageEntity:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomerApi_V1_DeclarationUploadEntity'
          description: Declaration upload
        pagination:
          allOf:
            - $ref: '#/components/schemas/CustomerApi_PaginationEntity'
          description: Pagination details
      required:
        - data
      description: CustomerApi_DeclarationUploadsPageEntity model
    CustomerApi_ErrorEntity:
      type: object
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
      required:
        - code
        - message
      description: CustomerApi_ErrorEntity model
    CustomerApi_V1_DeclarationUploadEntity:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier
        status:
          type: string
          enum:
            - queued
            - retry
            - started
            - failure
            - success
            - system_error
          description: >-
            Processing status of the upload (queued, retry, started, failure,
            success, system_error)
        status_reason:
          type: string
          description: Reason for the status, set when processing failed
        declaration_type:
          type: string
          description: Type of the uploaded declaration file
        success_count:
          type: integer
          format: int32
          description: Number of rows processed successfully
        warning_count:
          type: integer
          format: int32
          description: Number of rows processed with a warning
        failed_count:
          type: integer
          format: int32
          description: Number of rows that failed
        debtors_created_count:
          type: integer
          format: int32
          description: Number of debtors created
        debtors_updated_count:
          type: integer
          format: int32
          description: Number of debtors updated
        invoices_created_count:
          type: integer
          format: int32
          description: Number of invoices created
        declarations_total_amount:
          type: string
          description: Total amount of the declarations in the file
        deeplink_url:
          type: string
          description: URL to the declaration upload in the debtor management interface
        log_lines:
          type: array
          items:
            $ref: '#/components/schemas/CustomerApi_V1_DeclarationUploadLogLineEntity'
          description: >-
            Failed and warning rows (derived, request with the 'fields'
            parameter)
        created_at:
          type: string
          format: date-time
          description: Timestamp at which the file was uploaded
        started_at:
          type: string
          format: date-time
          description: Timestamp at which processing started
        finished_at:
          type: string
          format: date-time
          description: Timestamp at which processing finished
      required:
        - id
        - status
        - declaration_type
        - success_count
        - warning_count
        - failed_count
        - created_at
      description: CustomerApi_V1_DeclarationUploadEntity model
    CustomerApi_PaginationEntity:
      type: object
      properties:
        cursor:
          type: string
          description: Cursor for fetching the next page
      required:
        - cursor
    CustomerApi_V1_DeclarationUploadLogLineEntity:
      type: object
      properties:
        severity:
          type: string
          enum:
            - error
            - warning
          description: >-
            Whether the row failed (error) or was processed with a warning
            (error, warning)
        debtor_code:
          type: string
          description: Code of the debtor the row is about
        debtor_name:
          type: string
          description: Name of the debtor the row is about
        invoice_numbers:
          type: array
          items:
            type: string
          description: Numbers of the invoices the row is about
        validation_errors:
          type: object
          description: Validation errors per attribute
      required:
        - severity
        - invoice_numbers
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        OAuth2 access token or static API token. See
        [Authorization](/authentication/authorization) for how to obtain one.

````

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