SUPER PDP API

https://www.superpdp.tech/openapi/
Admin
SUPER PDP API is an electronic invoicing platform that enables developers to programmatically send,...
Tokens:7,677
Snippets:47
Trust Score:6.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /v1.beta/invoices/{id}/download

Source: https://www.superpdp.tech/openapi/#description/introduction

Downloads a specific invoice file.

```APIDOC
## GET /v1.beta/invoices/{id}/download

### Description
Downloads a specific invoice file.

### Method
GET

### Endpoint
/v1.beta/invoices/{id}/download

### Parameters
#### Path Parameters
- **id** (string) - Required - The invoice ID.

### Response
#### Success Response (200)
- **file** (binary) - The invoice file content.

#### Response Example
[Binary file content]
```

--------------------------------

### GET /v1.beta/companies/me

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves the authenticated company's information.

```APIDOC
## GET /v1.beta/companies/me

### Description
Retrieves the authenticated company's information.

### Method
GET

### Endpoint
/v1.beta/companies/me

### Response
#### Success Response (200)
- **company** (object) - The company object.

#### Response Example
{
  "company": {
    "id": "123",
    "name": "Acme Corp"
  }
}
```

--------------------------------

### GET /v1.beta/directory_entries/{id}

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a specific directory entry by its ID.

```APIDOC
## GET /v1.beta/directory_entries/{id}

### Description
Retrieves a specific directory entry by its ID.

### Method
GET

### Endpoint
/v1.beta/directory_entries/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The directory entry ID.

### Response
#### Success Response (200)
- **entry** (object) - The directory entry object.

#### Response Example
{
  "entry": {
    "id": "dir_123",
    "name": "Acme Corp"
  }
}
```

--------------------------------

### GET /v1.beta/directory_entries

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a list of directory entries. This endpoint returns entries from the directory.

```APIDOC
## GET /v1.beta/directory_entries

### Description
Retrieves a list of directory entries. This endpoint returns entries from the directory.

### Method
GET

### Endpoint
/v1.beta/directory_entries

### Response
#### Success Response (200)
- **entries** (array) - List of directory entry objects.

#### Response Example
{
  "entries": [
    {
      "id": "dir_123",
      "name": "Acme Corp"
    }
  ]
}
```

--------------------------------

### GET /v1.beta/invoices

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a list of invoices. This endpoint returns invoices accessible to the authenticated user.

```APIDOC
## GET /v1.beta/invoices

### Description
Retrieves a list of invoices. This endpoint returns invoices accessible to the authenticated user.

### Method
GET

### Endpoint
/v1.beta/invoices

### Response
#### Success Response (200)
- **invoices** (array) - List of invoice objects.

#### Response Example
{
  "invoices": [
    {
      "id": "inv_123",
      "amount": 100.00
    }
  ]
}
```

--------------------------------

### GET /v1.beta/ereportings/preview

Source: https://www.superpdp.tech/openapi/#description/introduction

Previews e-reportings. This endpoint is part of the e-reporting operations for retrieving transmitted data.

```APIDOC
## GET /v1.beta/ereportings/preview

### Description
Preview e-reportings. This endpoint is part of the e-reporting operations for retrieving transmitted data.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/ereportings/preview

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/company_mandates/{id}/download

Source: https://www.superpdp.tech/openapi/#description/introduction

Downloads a company mandate by ID. This endpoint is part of the company mandates operations.

```APIDOC
## GET /v1.beta/company_mandates/{id}/download

### Description
Download a company mandate by ID. This endpoint is part of the company mandates operations.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/company_mandates/{id}/download

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the company mandate.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/invoices/{id}

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a specific invoice by its ID.

```APIDOC
## GET /v1.beta/invoices/{id}

### Description
Retrieves a specific invoice by its ID.

### Method
GET

### Endpoint
/v1.beta/invoices/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The invoice ID.

### Response
#### Success Response (200)
- **invoice** (object) - The invoice object.

#### Response Example
{
  "invoice": {
    "id": "inv_123",
    "amount": 100.00
  }
}
```

--------------------------------

### GET /v1.beta/company_mandates

Source: https://www.superpdp.tech/openapi/#description/introduction

Lists company mandates. This endpoint is part of the company mandates operations.

```APIDOC
## GET /v1.beta/company_mandates

### Description
List company mandates. This endpoint is part of the company mandates operations.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/company_mandates

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/invoices/generate_test_invoice

Source: https://www.superpdp.tech/openapi/#description/introduction

Generates a test invoice. This endpoint is useful for testing invoice processing without real data.

```APIDOC
## GET /v1.beta/invoices/generate_test_invoice

### Description
Generates a test invoice. This endpoint is useful for testing invoice processing without real data.

### Method
GET

### Endpoint
/v1.beta/invoices/generate_test_invoice

### Response
#### Success Response (200)
- **invoice** (object) - The generated test invoice.

#### Response Example
{
  "invoice": {
    "id": "test_inv",
    "amount": 0.00
  }
}
```

--------------------------------

### GET /v1.beta/ereportings

Source: https://www.superpdp.tech/openapi/#description/introduction

Lists e-reportings. This endpoint is part of the e-reporting operations for retrieving transmitted data.

```APIDOC
## GET /v1.beta/ereportings

### Description
List e-reportings. This endpoint is part of the e-reporting operations for retrieving transmitted data.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/ereportings

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/french_directory/entries

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a list of entries from the French directory. This endpoint returns directory entries for French e-invoicing compliance.

```APIDOC
## GET /v1.beta/french_directory/entries

### Description
Retrieves a list of entries from the French directory. This endpoint returns directory entries for French e-invoicing compliance.

### Method
GET

### Endpoint
/v1.beta/french_directory/entries

### Response
#### Success Response (200)
- **entries** (array) - List of directory entry objects.

#### Response Example
{
  "entries": [
    {
      "id": "fr_123",
      "name": "Acme Corp"
    }
  ]
}
```

--------------------------------

### GET /v1.beta/invoice_events

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a list of invoice events. This endpoint returns events related to invoices.

```APIDOC
## GET /v1.beta/invoice_events

### Description
Retrieves a list of invoice events. This endpoint returns events related to invoices.

### Method
GET

### Endpoint
/v1.beta/invoice_events

### Response
#### Success Response (200)
- **events** (array) - List of event objects.

#### Response Example
{
  "events": [
    {
      "id": "evt_123",
      "type": "created"
    }
  ]
}
```

--------------------------------

### GET /v1.beta/company_mandates/{id}

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a company mandate by ID. This endpoint is part of the company mandates operations.

```APIDOC
## GET /v1.beta/company_mandates/{id}

### Description
Retrieve a company mandate by ID. This endpoint is part of the company mandates operations.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/company_mandates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the company mandate.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/b2bint_invoices

Source: https://www.superpdp.tech/openapi/#description/introduction

Lists B2BInt invoices. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

```APIDOC
## GET /v1.beta/b2bint_invoices

### Description
List B2BInt invoices. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/b2bint_invoices

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/b2bint_payments

Source: https://www.superpdp.tech/openapi/#description/introduction

Lists B2BInt payments. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

```APIDOC
## GET /v1.beta/b2bint_payments

### Description
List B2BInt payments. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/b2bint_payments

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/french_directory/companies

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a list of companies from the French directory. This endpoint lists entities that must comply with the French e-invoicing reform.

```APIDOC
## GET /v1.beta/french_directory/companies

### Description
Retrieves a list of companies from the French directory. This endpoint lists entities that must comply with the French e-invoicing reform.

### Method
GET

### Endpoint
/v1.beta/french_directory/companies

### Response
#### Success Response (200)
- **companies** (array) - List of company objects.

#### Response Example
{
  "companies": [
    {
      "id": "fr_123",
      "name": "Acme Corp"
    }
  ]
}
```

--------------------------------

### GET /v1.beta/oauth2_sessions/me

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves the current OAuth2 session status. Use this endpoint to monitor the authorization status after a successful OAuth2 flow.

```APIDOC
## GET /v1.beta/oauth2_sessions/me

### Description
Retrieves the current OAuth2 session status. Use this endpoint to monitor the authorization status after a successful OAuth2 flow.

### Method
GET

### Endpoint
/v1.beta/oauth2_sessions/me

### Response
#### Success Response (200)
- **status** (string) - The session authorization status.

#### Response Example
{
  "status": "verified"
}
```

--------------------------------

### GET /v1.beta/ereportings/{id}

Source: https://www.superpdp.tech/openapi/#description/introduction

Retrieves a specific e-reporting by ID. This endpoint is part of the e-reporting operations for retrieving transmitted data.

```APIDOC
## GET /v1.beta/ereportings/{id}

### Description
Retrieve a specific e-reporting by ID. This endpoint is part of the e-reporting operations for retrieving transmitted data.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/ereportings/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the e-reporting.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/b2c_transactions

Source: https://www.superpdp.tech/openapi/#description/introduction

Lists B2C transactions. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

```APIDOC
## GET /v1.beta/b2c_transactions

### Description
List B2C transactions. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/b2c_transactions

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### GET /v1.beta/b2c_payments

Source: https://www.superpdp.tech/openapi/#description/introduction

Lists B2C payments. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

```APIDOC
## GET /v1.beta/b2c_payments

### Description
List B2C payments. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

### Method
GET

### Endpoint
https://api.superpdp.tech/v1.beta/b2c_payments

### Parameters
No parameters documented.

### Response
No response schema documented.

```

--------------------------------

### POST /v1.beta/directory_entries

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a new directory entry. This endpoint adds an entry to the directory.

```APIDOC
## POST /v1.beta/directory_entries

### Description
Creates a new directory entry. This endpoint adds an entry to the directory.

### Method
POST

### Endpoint
/v1.beta/directory_entries

### Parameters
#### Request Body
- **entry** (object) - Required - The directory entry details.

### Request Example
{
  "entry": {
    "name": "Acme Corp",
    "registration_number": "123456789"
  }
}

### Response
#### Success Response (201)
- **entry** (object) - The created directory entry.

#### Response Example
{
  "entry": {
    "id": "dir_123",
    "name": "Acme Corp"
  }
}
```

--------------------------------

### POST /v1.beta/companies

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a new company. This endpoint registers a company entity in the system.

```APIDOC
## POST /v1.beta/companies

### Description
Creates a new company. This endpoint registers a company entity in the system.

### Method
POST

### Endpoint
/v1.beta/companies

### Parameters
#### Request Body
- **company** (object) - Required - The company details to create.

### Request Example
{
  "company": {
    "name": "Acme Corp",
    "registration_number": "123456789"
  }
}

### Response
#### Success Response (201)
- **company** (object) - The created company object.

#### Response Example
{
  "company": {
    "id": "123",
    "name": "Acme Corp"
  }
}
```

--------------------------------

### POST /v1.beta/invoices

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a new invoice. This endpoint allows submitting an invoice for processing.

```APIDOC
## POST /v1.beta/invoices

### Description
Creates a new invoice. This endpoint allows submitting an invoice for processing.

### Method
POST

### Endpoint
/v1.beta/invoices

### Parameters
#### Request Body
- **invoice** (object) - Required - The invoice details.

### Request Example
{
  "invoice": {
    "amount": 100.00,
    "currency": "EUR"
  }
}

### Response
#### Success Response (201)
- **invoice** (object) - The created invoice object.

#### Response Example
{
  "invoice": {
    "id": "inv_123",
    "amount": 100.00
  }
}
```

--------------------------------

### POST /v1.beta/b2bint_invoices

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a B2BInt invoice. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

```APIDOC
## POST /v1.beta/b2bint_invoices

### Description
Create a B2BInt invoice. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

### Method
POST

### Endpoint
https://api.superpdp.tech/v1.beta/b2bint_invoices

### Parameters
No parameters documented.

### Request Body
No request body documented.

### Response
No response schema documented.

```

--------------------------------

### POST /v1.beta/b2bint_payments

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a B2BInt payment. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

```APIDOC
## POST /v1.beta/b2bint_payments

### Description
Create a B2BInt payment. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

### Method
POST

### Endpoint
https://api.superpdp.tech/v1.beta/b2bint_payments

### Parameters
No parameters documented.

### Request Body
No request body documented.

### Response
No response schema documented.

```

--------------------------------

### POST /v1.beta/invoice_events

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a new invoice event. This endpoint allows recording an event for an invoice.

```APIDOC
## POST /v1.beta/invoice_events

### Description
Creates a new invoice event. This endpoint allows recording an event for an invoice.

### Method
POST

### Endpoint
/v1.beta/invoice_events

### Parameters
#### Request Body
- **event** (object) - Required - The event details.

### Request Example
{
  "event": {
    "invoice_id": "inv_123",
    "type": "sent"
  }
}

### Response
#### Success Response (201)
- **event** (object) - The created event.

#### Response Example
{
  "event": {
    "id": "evt_123",
    "type": "sent"
  }
}
```

--------------------------------

### POST /v1.beta/company_mandates

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a company mandate. This endpoint is part of the company mandates operations.

```APIDOC
## POST /v1.beta/company_mandates

### Description
Create a company mandate. This endpoint is part of the company mandates operations.

### Method
POST

### Endpoint
https://api.superpdp.tech/v1.beta/company_mandates

### Parameters
No parameters documented.

### Request Body
No request body documented.

### Response
No response schema documented.

```

--------------------------------

### POST /v1.beta/invoices/convert

Source: https://www.superpdp.tech/openapi/#description/introduction

Converts an invoice to a different format. This endpoint is used to transform invoice data.

```APIDOC
## POST /v1.beta/invoices/convert

### Description
Converts an invoice to a different format. This endpoint is used to transform invoice data.

### Method
POST

### Endpoint
/v1.beta/invoices/convert

### Parameters
#### Request Body
- **invoice** (object) - Required - The invoice to convert.

### Request Example
{
  "invoice": {
    "id": "inv_123"
  }
}

### Response
#### Success Response (200)
- **converted_invoice** (object) - The converted invoice object.

#### Response Example
{
  "converted_invoice": {
    "id": "inv_123",
    "format": "PDF"
  }
}
```

--------------------------------

### DELETE /v1.beta/directory_entries/{id}

Source: https://www.superpdp.tech/openapi/#description/introduction

Deletes a specific directory entry by its ID.

```APIDOC
## DELETE /v1.beta/directory_entries/{id}

### Description
Deletes a specific directory entry by its ID.

### Method
DELETE

### Endpoint
/v1.beta/directory_entries/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The directory entry ID.

### Response
#### Success Response (204)
No content.
```

--------------------------------

### POST /v1.beta/b2c_payments

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a B2C payment. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

```APIDOC
## POST /v1.beta/b2c_payments

### Description
Create a B2C payment. This endpoint is part of the e-reporting operations for transmitting payment data to the French tax administration.

### Method
POST

### Endpoint
https://api.superpdp.tech/v1.beta/b2c_payments

### Parameters
No parameters documented.

### Request Body
No request body documented.

### Response
No response schema documented.

```

--------------------------------

### POST /v1.beta/validation_reports

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a validation report. This endpoint is used to submit a validation report for an invoice.

```APIDOC
## POST /v1.beta/validation_reports

### Description
Creates a validation report. This endpoint is used to submit a validation report for an invoice.

### Method
POST

### Endpoint
/v1.beta/validation_reports

### Parameters
#### Request Body
- **report** (object) - Required - The validation report details.

### Request Example
{
  "report": {
    "invoice_id": "inv_123",
    "status": "valid"
  }
}

### Response
#### Success Response (201)
- **report** (object) - The created validation report.

#### Response Example
{
  "report": {
    "id": "rep_123",
    "status": "valid"
  }
}
```

--------------------------------

### POST /v1.beta/b2c_transactions

Source: https://www.superpdp.tech/openapi/#description/introduction

Creates a B2C transaction. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

```APIDOC
## POST /v1.beta/b2c_transactions

### Description
Create a B2C transaction. This endpoint is part of the e-reporting operations for transmitting transaction data to the French tax administration.

### Method
POST

### Endpoint
https://api.superpdp.tech/v1.beta/b2c_transactions

### Parameters
No parameters documented.

### Request Body
No request body documented.

### Response
No response schema documented.

```

--------------------------------

### PATCH /v1.beta/companies

Source: https://www.superpdp.tech/openapi/#description/introduction

Updates company information. This endpoint is part of the e-reporting operations for transmitting data to the French tax administration.

```APIDOC
## PATCH /v1.beta/companies

### Description
Update company information. This endpoint is part of the e-reporting operations for transmitting data to the French tax administration.

### Method
PATCH

### Endpoint
https://api.superpdp.tech/v1.beta/companies

### Parameters
No parameters documented.

### Request Body
No request body documented.

### Response
No response schema documented.

```

--------------------------------

### PATCH /v1.beta/companies

Source: https://www.superpdp.tech/openapi/#description/introduction

Updates company information. This endpoint allows modifying details of the authenticated company.

```APIDOC
## PATCH /v1.beta/companies

### Description
Updates company information. This endpoint allows modifying details of the authenticated company.

### Method
PATCH

### Endpoint
/v1.beta/companies

### Parameters
#### Request Body
- **company** (object) - Required - The company fields to update.

### Request Example
{
  "company": {
    "name": "New Name"
  }
}

### Response
#### Success Response (200)
- **company** (object) - The updated company object.

#### Response Example
{
  "company": {
    "id": "123",
    "name": "New Name"
  }
}
```

--------------------------------

### DELETE /v1.beta/company_mandates/{id}

Source: https://www.superpdp.tech/openapi/#description/introduction

Deletes a company mandate by ID. This endpoint is part of the company mandates operations.

```APIDOC
## DELETE /v1.beta/company_mandates/{id}

### Description
Delete a company mandate by ID. This endpoint is part of the company mandates operations.

### Method
DELETE

### Endpoint
https://api.superpdp.tech/v1.beta/company_mandates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the company mandate.

### Response
No response schema documented.

```
Tokens:
Raw