Pamplemousse est un service qui permet de générer des factures au format Factur-x. Vous pouvez aussi extraire les informations contenues dans une facture au format facture X.
Pour pouvoir commencer a utiliser notre service vous devez créer un compte sur Pamplemousse.
Pour utiliser nos APIs, vous devez authentifier vos requêtes en ajoutant le header suivant :
x-api-key: your-api-key
Votre clé api est disponible sur la plateforme.
Lance la generation d'une facture
Creer une nouvelle facture au format factur-X et retourne l'identifiant de la generation
Authorizations:
Request Body schema: application/json
required | object | ||||||||||||||||||||||
| |||||||||||||||||||||||
Responses
Request samples
- Payload
{- "data": {
- "invoice_id": "string",
- "currency": "EUR",
- "due_date": "string",
- "invoice_date": "string",
- "shipped_date": "string",
- "invoice_legal_note": "En cas de retard, une pénalité au taux annuel de 5 % sera appliquée, à laquelle s'ajoutera une indemnité forfaitaire pour frais de recouvrement de 40 €",
- "invoice_note": "string",
- "buyer": {
- "id": "string",
- "name": "string",
- "trading_name": "string",
- "legal_registration_id": "stringstr",
- "vat_identifier": "string",
- "registration_form": "string",
- "share_capital": 0,
- "tax_registration_id": "string",
- "additional_legal_information": "string",
- "email": "string",
- "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "address_line_3": "string",
- "city": "string",
- "post_code": "string",
- "country_subdivision": "string",
- "country": "FR"
}, - "phone_number": "string"
}, - "seller": {
- "id": "string",
- "name": "string",
- "trading_name": "string",
- "legal_registration_id": "stringstr",
- "vat_identifier": "string",
- "registration_form": "string",
- "share_capital": 0,
- "tax_registration_id": "string",
- "additional_legal_information": "string",
- "email": "string",
- "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "address_line_3": "string",
- "city": "string",
- "post_code": "string",
- "country_subdivision": "string",
- "country": "FR"
}, - "phone_number": "string"
}, - "lines": [
- {
- "name": "string",
- "description": "string",
- "quantity": 0,
- "unit_price": 0,
- "vat_rate": 0,
- "discount": 0,
- "vat_category": "string"
}
], - "delivery_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "address_line_3": "string",
- "city": "string",
- "post_code": "string",
- "country_subdivision": "string",
- "country": "FR"
}
}
}Response samples
- 200
- default
{- "id": "string",
- "status": "string",
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z"
}Retourrne une facture
Retourrne les informations de la generation d'une facture specifique
Authorizations:
path Parameters
| id required | string^c[^\s-]{8,}$ |
Responses
Response samples
- 200
- default
{- "id": "string",
- "status": "string",
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z"
}Extrait les informations d'une facture
Extrait les informations d'une facture au format factur-X
Authorizations:
Request Body schema: application/json
| data required | string Le contenu du fichier PDF en base64 |
Responses
Request samples
- Payload
{- "data": "string"
}Response samples
- 200
- default
{- "id": "string",
- "url": "string"
}