RecurringInvoice

Recurring invoice schedules (pause, resume, generate)

GET /api/v1/recurring/invoices#

GET /api/v1/recurring/invoices

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

curl -X GET "https://app.encryptinvoice.com/api/v1/recurring/invoices" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

POST /api/v1/recurring/invoices#

POST /api/v1/recurring/invoices

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Corps de la requête#

Réponses#

Exemple de requête#

curl -X POST "https://app.encryptinvoice.com/api/v1/recurring/invoices" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": 1,
    "name": "string",
    "frequency": "string",
    "interval": 1,
    "start_date": "string",
    "end_date": "string",
    "max_occurrences": 1,
    "auto_send": true,
    "currency": "string",
    "payment_terms_days": 1,
    "items": []
}'

GET /api/v1/recurring/invoices/{id}#

GET /api/v1/recurring/invoices/{id}

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

curl -X GET "https://app.encryptinvoice.com/api/v1/recurring/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

PUT /api/v1/recurring/invoices/{id}#

PUT /api/v1/recurring/invoices/{id}

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Corps de la requête#

Réponses#

Exemple de requête#

curl -X PUT "https://app.encryptinvoice.com/api/v1/recurring/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "frequency": "string",
    "interval": 1,
    "end_date": "string",
    "max_occurrences": 1,
    "auto_send": true,
    "payment_terms_days": 1,
    "items": []
}'

DELETE /api/v1/recurring/invoices/{id}#

DELETE /api/v1/recurring/invoices/{id}

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

curl -X DELETE "https://app.encryptinvoice.com/api/v1/recurring/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

POST /api/v1/recurring/invoices/{id}/generate#

POST /api/v1/recurring/invoices/{id}/generate

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

curl -X POST "https://app.encryptinvoice.com/api/v1/recurring/invoices/{id}/generate" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

POST /api/v1/recurring/invoices/{id}/pause#

POST /api/v1/recurring/invoices/{id}/pause

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

curl -X POST "https://app.encryptinvoice.com/api/v1/recurring/invoices/{id}/pause" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

POST /api/v1/recurring/invoices/{id}/resume#

POST /api/v1/recurring/invoices/{id}/resume

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

curl -X POST "https://app.encryptinvoice.com/api/v1/recurring/invoices/{id}/resume" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"