Skip to content

Seqino PDP API (1.0.0)

Seqino PDP API - Modern interface to France's e-Invoicing services

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://pdp.seqino.dev/

Languages
Servers
Dev server

https://pdp.seqino.dev/api/

Local development server

http://localhost:8052/

👥 Clients

Operations

📋 Mandates

Operations

📝 Drafts

Operations

📘 Directory

Operations

🧾 Invoicing

Operations

🔄 Lifecycle

Operations

📊 Reporting

Operations

📊 Usage

Operations

📈 Get usage metrics for a company

Request

Get detailed usage metrics for a company within a specified period.

Query
periodstring(UsagePeriod)
Default "monthly"
Enum"daily""weekly""monthly""yearly"
start_dateStart Date (string) or Start Date (null)(Start Date)
Any of:

Start date for custom period

string(date)(Start Date)
end_dateEnd Date (string) or End Date (null)(End Date)
Any of:

End date for custom period

string(date)(End Date)
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
curl -i -X GET \
  'https://pdp.seqino.dev/api/usage/metrics?period=monthly&start_date=2019-08-24&end_date=2019-08-24' \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Bodyapplication/json
company_idstring(Company Id)required
periodstring(UsagePeriod)required
Enum"daily""weekly""monthly""yearly"
start_datestring(date)(Start Date)required
end_datestring(date)(End Date)required
total_api_callsinteger(Total Api Calls)>= 0required

Total number of API calls

total_successful_callsinteger(Total Successful Calls)>= 0required

Total successful API calls

total_failed_callsinteger(Total Failed Calls)>= 0required

Total failed API calls

success_ratenumber(Success Rate)[ 0 .. 100 ]required

Success rate percentage

endpoint_usageArray of objects(Endpoint Usage)required

Usage breakdown by endpoint

endpoint_usage[].​endpointstring(Endpoint)required

API endpoint path

endpoint_usage[].​methodstring(Method)required

HTTP method

endpoint_usage[].​call_countinteger(Call Count)>= 0required

Number of calls made

endpoint_usage[].​success_countinteger(Success Count)>= 0required

Number of successful calls (2xx status)

endpoint_usage[].​error_countinteger(Error Count)>= 0required

Number of failed calls (4xx/5xx status)

endpoint_usage[].​avg_response_time_msnumber(Avg Response Time Ms)>= 0required

Average response time in milliseconds

generated_atstring(date-time)(Generated At)
Response
application/json
{
  "company_id": "string",
  "period": "daily",
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "total_api_calls": 0,
  "total_successful_calls": 0,
  "total_failed_calls": 0,
  "success_rate": 100,
  "endpoint_usage": [
    { … }
  ],
  "generated_at": "2019-08-24T14:15:22Z"
}

📋 Get usage summary for a company

Request

Get a high-level usage summary for a company.

Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
curl -i -X GET \
  https://pdp.seqino.dev/api/usage/summary \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Bodyapplication/json
company_idstring(Company Id)required
current_month_callsinteger(Current Month Calls)>= 0required

API calls in current month

previous_month_callsinteger(Previous Month Calls)>= 0required

API calls in previous month

month_over_month_changenumber(Month Over Month Change)required

Percentage change from previous month

most_used_endpointMost Used Endpoint (string) or Most Used Endpoint (null)(Most Used Endpoint)required
Any of:

Most frequently used endpoint

string(Most Used Endpoint)
least_used_endpointLeast Used Endpoint (string) or Least Used Endpoint (null)(Least Used Endpoint)required
Any of:

Least frequently used endpoint

string(Least Used Endpoint)
peak_usage_dayPeak Usage Day (string) or Peak Usage Day (null)(Peak Usage Day)required
Any of:

Day with highest usage

string(date)(Peak Usage Day)
peak_usage_countPeak Usage Count (integer) or Peak Usage Count (null)(Peak Usage Count)required
Any of:

Highest daily usage count

>= 0
integer(Peak Usage Count)>= 0
Response
application/json
{
  "company_id": "string",
  "current_month_calls": 0,
  "previous_month_calls": 0,
  "month_over_month_change": 0,
  "most_used_endpoint": "string",
  "least_used_endpoint": "string",
  "peak_usage_day": "2019-08-24",
  "peak_usage_count": 0
}

⚡ Get usage limits and current usage for a company

Request

Get usage limits and current usage statistics for a company.

Query
endpointEndpoint (string) or Endpoint (null)(Endpoint)
Any of:

Filter by specific endpoint

string(Endpoint)
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
curl -i -X GET \
  'https://pdp.seqino.dev/api/usage/limits?endpoint=string' \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Bodyapplication/json
limitsArray of objects(Limits)required
limits[].​company_idstring(Company Id)required
limits[].​endpointstring(Endpoint)required
limits[].​methodstring(Method)required
limits[].​limit_per_minuteLimit Per Minute (integer) or Limit Per Minute (null)(Limit Per Minute)
Any of:

Rate limit per minute

>= 1
integer(Limit Per Minute)>= 1
limits[].​limit_per_hourLimit Per Hour (integer) or Limit Per Hour (null)(Limit Per Hour)
Any of:

Rate limit per hour

>= 1
integer(Limit Per Hour)>= 1
limits[].​limit_per_dayLimit Per Day (integer) or Limit Per Day (null)(Limit Per Day)
Any of:

Rate limit per day

>= 1
integer(Limit Per Day)>= 1
limits[].​limit_per_monthLimit Per Month (integer) or Limit Per Month (null)(Limit Per Month)
Any of:

Rate limit per month

>= 1
integer(Limit Per Month)>= 1
limits[].​current_usage_minuteinteger(Current Usage Minute)>= 0required

Current usage in the current minute

limits[].​current_usage_hourinteger(Current Usage Hour)>= 0required

Current usage in the current hour

limits[].​current_usage_dayinteger(Current Usage Day)>= 0required

Current usage in the current day

limits[].​current_usage_monthinteger(Current Usage Month)>= 0required

Current usage in the current month

total_countinteger(Total Count)required
Response
application/json
{
  "limits": [
    { … }
  ],
  "total_count": 0
}

⚙️ Set usage limits for a company endpoint

Request

Set or update usage limits for a specific company endpoint.

Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
Bodyapplication/jsonrequired
company_idstring(Company Id)required
endpointstring(Endpoint)required
methodstring(Method)required
limit_per_minuteLimit Per Minute (integer) or Limit Per Minute (null)(Limit Per Minute)
Any of:

Rate limit per minute

>= 1
integer(Limit Per Minute)>= 1
limit_per_hourLimit Per Hour (integer) or Limit Per Hour (null)(Limit Per Hour)
Any of:

Rate limit per hour

>= 1
integer(Limit Per Hour)>= 1
limit_per_dayLimit Per Day (integer) or Limit Per Day (null)(Limit Per Day)
Any of:

Rate limit per day

>= 1
integer(Limit Per Day)>= 1
limit_per_monthLimit Per Month (integer) or Limit Per Month (null)(Limit Per Month)
Any of:

Rate limit per month

>= 1
integer(Limit Per Month)>= 1
current_usage_minuteinteger(Current Usage Minute)>= 0required

Current usage in the current minute

current_usage_hourinteger(Current Usage Hour)>= 0required

Current usage in the current hour

current_usage_dayinteger(Current Usage Day)>= 0required

Current usage in the current day

current_usage_monthinteger(Current Usage Month)>= 0required

Current usage in the current month

curl -i -X POST \
  https://pdp.seqino.dev/api/usage/limits \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "company_id": "string",
    "endpoint": "string",
    "method": "string",
    "limit_per_minute": 1,
    "limit_per_hour": 1,
    "limit_per_day": 1,
    "limit_per_month": 1,
    "current_usage_minute": 0,
    "current_usage_hour": 0,
    "current_usage_day": 0,
    "current_usage_month": 0
  }'

Responses

Successful Response

Bodyapplication/json
company_idstring(Company Id)required
endpointstring(Endpoint)required
methodstring(Method)required
limit_per_minuteLimit Per Minute (integer) or Limit Per Minute (null)(Limit Per Minute)
Any of:

Rate limit per minute

>= 1
integer(Limit Per Minute)>= 1
limit_per_hourLimit Per Hour (integer) or Limit Per Hour (null)(Limit Per Hour)
Any of:

Rate limit per hour

>= 1
integer(Limit Per Hour)>= 1
limit_per_dayLimit Per Day (integer) or Limit Per Day (null)(Limit Per Day)
Any of:

Rate limit per day

>= 1
integer(Limit Per Day)>= 1
limit_per_monthLimit Per Month (integer) or Limit Per Month (null)(Limit Per Month)
Any of:

Rate limit per month

>= 1
integer(Limit Per Month)>= 1
current_usage_minuteinteger(Current Usage Minute)>= 0required

Current usage in the current minute

current_usage_hourinteger(Current Usage Hour)>= 0required

Current usage in the current hour

current_usage_dayinteger(Current Usage Day)>= 0required

Current usage in the current day

current_usage_monthinteger(Current Usage Month)>= 0required

Current usage in the current month

Response
application/json
{
  "company_id": "string",
  "endpoint": "string",
  "method": "string",
  "limit_per_minute": 1,
  "limit_per_hour": 1,
  "limit_per_day": 1,
  "limit_per_month": 1,
  "current_usage_minute": 0,
  "current_usage_hour": 0,
  "current_usage_day": 0,
  "current_usage_month": 0
}

🚨 Get usage alerts for a company

Request

Get usage alerts and warnings for a company.

Query
active_onlyboolean(Active Only)

Return only active alerts

Default true
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
curl -i -X GET \
  'https://pdp.seqino.dev/api/usage/alerts?active_only=true' \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Bodyapplication/json
alertsArray of objects(Alerts)required
alerts[].​company_idstring(Company Id)required
alerts[].​alert_typestring(Alert Type)required

Type of alert (e.g., 'rate_limit_approaching', 'quota_exceeded')

alerts[].​threshold_percentagenumber(Threshold Percentage)[ 0 .. 100 ]required

Threshold percentage that triggered the alert

alerts[].​current_usageinteger(Current Usage)>= 0required

Current usage count

alerts[].​limitinteger(Limit)>= 1required

Usage limit

alerts[].​endpointEndpoint (string) or Endpoint (null)(Endpoint)required
Any of:

Specific endpoint if applicable

string(Endpoint)
alerts[].​created_atstring(date-time)(Created At)
alerts[].​messagestring(Message)required

Human-readable alert message

total_countinteger(Total Count)required
Response
application/json
{
  "alerts": [
    { … }
  ],
  "total_count": 0
}

📊 Get mandate statistics

Request

Get mandate statistics for a sponsor.

Returns the total number of mandates and average number of mandates per client for the sponsor identified by the X-PDP-Sponsor-Id header.

curl -i -X GET \
  https://pdp.seqino.dev/api/usage/mandates

Responses

Mandate statistics for the sponsor

Bodyapplication/json
total_mandatesinteger(Total Mandates)required

Total number of mandates for the sponsor

average_mandates_per_clientnumber(Average Mandates Per Client)required

Average number of mandates per client

Response
application/json
{
  "total_mandates": 0,
  "average_mandates_per_client": 0
}

📊 Get client statistics

Request

Get client statistics for a sponsor.

Returns the total number of clients for the sponsor identified by the X-PDP-Sponsor-Id header.

curl -i -X GET \
  https://pdp.seqino.dev/api/usage/clients

Responses

Client statistics for the sponsor

Bodyapplication/json
total_clientsinteger(Total Clients)required

Total number of clients for the sponsor

Response
application/json
{
  "total_clients": 0
}

⚙️ Settings

Operations