API Frais
Principes de base
Cet objet représente des frais ou commissions associés à une transaction ou un produit spécifique. Utilisez-le pour gérer les différents frais facturés à vos clients.
Portées
fees:read
fees:write
Créer des frais
Permet de créer des frais pour votre entreprise. Nécéssite la portée fees:write.
POST https://api.smartbills.io/v1/fees
Requête
Corps de la requête
Vous devez fournir un corps de requête de type FeeCreateRequest.
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
name | Nom du frais | string | obligatoire |
description | Description du frais | string | facultatif |
amount | Montant des frais | decimal | obligatoire |
currency | Devise des frais (ex. USD, CAD) | string | obligatoire |
isRecurring | Est-ce un frais récurrent ? | bool | facultatif |
Réponse
Corps de la réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
201 | Les frais ont été créés avec succès |
400 | La requête envoyée n'est pas valide. |
Récupérer des frais
Récupère un frais de l'entreprise. Nécéssite la portée fees:read.
GET https://api.smartbills.io/v1/fees/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique du frais | long | obligatoire |
Réponse
Récupérer une liste de frais
Récupère une liste de frais de l'entreprise. Nécéssite la portée fees:read.
GET https://api.smartbills.io/v1/fees
Paramètres de requête
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
page | Numéro de la page | long | obligatoire |
pageSize | Nombre d'enregistrements à retourner | long | obligatoire |
Réponse
Mettre à jour des frais
Permet de mettre à jour les informations d'un frais pour votre entreprise. Nécéssite la portée fees:write.
PUT https://api.smartbills.io/v1/fees/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique du frais | long | obligatoire |
Corps de la requête
Vous devez fournir un corps de requête de type FeeCreateRequest.
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
name | Nom du frais | string | obligatoire |
description | Description du frais | string | facultatif |
amount | Montant des frais | decimal | obligatoire |
currency | Devise des frais (ex. USD, CAD) | string | obligatoire |
isRecurring | Est-ce un frais récurrent ? | bool | facultatif |
Réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
200 | Les frais ont été mis à jour avec succès |
400 | La requête envoyée n'est pas valide |
404 | Aucun frais n'a été trouvé |
Supprimer des frais
Permet de supprimer des frais pour votre entreprise.
Nécéssite la portée fees:write.
DELETE https://api.smartbills.io/v1/fees/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique du frais | long | obligatoire |
Réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
200 | Les frais ont été supprimés avec succès |
404 | Aucun frais n'a été trouvé |