Invoice

Core invoice CRUD and lifecycle actions (send, mark paid/sent, PDF, duplicate)

Display a listing of invoices#

GET /api/v1/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/invoices" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Store a newly created invoice#

POST /api/v1/invoices

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

Per-line tax handling (Epic #617): each item may set tax_exempt: true (no tax on that line) or supply tax_rate_ids (explicit organization TaxRate ids). When a line provides neither, the organization's default tax rates are auto-applied. Item responses return the resolved unified tax-lines in tax_rates.

Corps de la requête#

Réponses#

Exemple de requête#

curl -X POST "https://app.encryptinvoice.com/api/v1/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,
    "issue_date": "string",
    "due_date": "string",
    "currency": "string",
    "notes": "string",
    "terms": "string",
    "items": []
}'

Display the specified invoice#

GET /api/v1/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/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Update the specified invoice#

PUT /api/v1/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/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": 1,
    "issue_date": "string",
    "due_date": "string",
    "currency": "string",
    "notes": "string",
    "terms": "string",
    "items": []
}'

Remove the specified invoice#

DELETE /api/v1/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/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Duplicate an invoice#

POST /api/v1/invoices/{id}/duplicate

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/invoices/{id}/duplicate" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Mark invoice as paid#

POST /api/v1/invoices/{id}/mark-paid

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 POST "https://app.encryptinvoice.com/api/v1/invoices/{id}/mark-paid" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_date": "string",
    "amount": 1,
    "amount_paid": 1,
    "payment_method": "string",
    "reference": "string",
    "payment_reference": "string",
    "notes": "string"
}'

Mark invoice as sent#

POST /api/v1/invoices/{id}/mark-sent

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 POST "https://app.encryptinvoice.com/api/v1/invoices/{id}/mark-sent" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "sent_at": "string",
    "sent_method": "string"
}'

Download invoice PDF#

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

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

Uses method injection for the PDF service (only this method needs it).

Paramètres#

Réponses#

Exemple de requête#

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

Send invoice via email#

POST /api/v1/invoices/{id}/send

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 POST "https://app.encryptinvoice.com/api/v1/invoices/{id}/send" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": "string",
    "message": "string",
    "attach_pdf": "string"
}'