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

# import data

> **/auth/importdata**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**/auth/importdata**

**Description:**\
The `/auth/importdata` endpoint allows users to import data by uploading a file, typically a CSV file containing relevant information. This endpoint is useful for importing data into the system for further processing or analysis.

**Method:**\
`POST`

**Request Parameters:**

| Parameter        | Type   | Description                                                 | Required |
| ---------------- | ------ | ----------------------------------------------------------- | -------- |
| file             | file   | The CSV file to be uploaded.                                | Yes      |
| accountingPeriod | string | The accounting period associated with the data (YYYY-MM-DD) | Yes      |
| salePeriod       | string | The sale period associated with the data (YYYY-MM-DD)       | Yes      |
| royaltySource    | string | The source of royalties for the imported data               | Yes      |

> **See response example below**

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/auth/importdata', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({})
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
    'https://api.royalti.io/auth/importdata',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/auth/importdata \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /auth/importdata
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /auth/importdata:
    post:
      tags:
        - Auth
      summary: import data
      description: >-
        **/auth/importdata**


        **Description:**  

        The `/auth/importdata` endpoint allows users to import data by uploading
        a file, typically a CSV file containing relevant information. This
        endpoint is useful for importing data into the system for further
        processing or analysis.


        **Method:**  

        `POST`


        **Request Parameters:**


        | Parameter | Type | Description | Required |

        | --- | --- | --- | --- |

        | file | file | The CSV file to be uploaded. | Yes |

        | accountingPeriod | string | The accounting period associated with the
        data (YYYY-MM-DD) | Yes |

        | salePeriod | string | The sale period associated with the data
        (YYYY-MM-DD) | Yes |

        | royaltySource | string | The source of royalties for the imported data
        | Yes |


        > **See response example below**
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: The CSV file to be uploaded
                accountingPeriod:
                  type: string
                  description: The accounting period associated with the data (YYYY-MM-DD)
                salePeriod:
                  type: string
                  description: The sale period associated with the data (YYYY-MM-DD)
                royaltySource:
                  type: string
                  description: The source of royalties for the imported data
              required:
                - file
                - accountingPeriod
                - salePeriod
                - royaltySource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: >-
                  Platform data Uploaded Successfully and Dataset being
                  processed
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````