API Taxes
Principes de base
Cet objet représente une taxe applicable à vos transactions. Utilisez-le pour définir et gérer les taxes à appliquer aux produits ou services dans votre système.
Portées
taxes:read
taxes:write
Créer une taxe
Permet de créer une taxe dans votre système. Nécessite la portée taxes:write.
POST https://api.smartbills.io/v1/taxes
Requête
Corps de la requête
Vous devez fournir un corps de requête de type TaxCreateRequest.
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
name | Nom de la taxe | string | obligatoire |
rate | Taux de la taxe en pourcentage | decimal | obligatoire |
description | Description de la taxe | string | facultatif |
Réponse
Corps de la réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
201 | La taxe a été créée avec succès |
400 | La requête envoyée n'est pas valide. |
Récupérer une taxe
Récupère les informations d'une taxe dans le système. Nécessite la portée taxes:read.
GET https://api.smartbills.io/v1/taxes/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique de la taxe | long | obligatoire |
Réponse
Récupérer une liste de taxes
Récupère une liste de taxes enregistrées dans le système. Nécessite la portée taxes:read.
GET https://api.smartbills.io/v1/taxes
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 une taxe
Permet de mettre à jour les informations d'une taxe dans le système. Nécessite la portée taxes:write.
PUT https://api.smartbills.io/v1/taxes/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique de la taxe | long | obligatoire |
Corps de la requête
Vous devez fournir un corps de requête de type TaxCreateRequest.
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
name | Nom de la taxe | string | obligatoire |
rate | Taux de la taxe en pourcentage | decimal | obligatoire |
description | Description de la taxe | string | facultatif |
Réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
200 | La taxe a été mise à jour avec succès |
400 | La requête envoyée n'est pas valide |
404 | Aucune taxe n'a été trouvée |
Supprimer une taxe
Permet de supprimer une taxe dans le système.
Nécessite la portée taxes:write.
DELETE https://api.smartbills.io/v1/taxes/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique de la taxe | long | obligatoire |
Réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
200 | La taxe a été supprimée avec succès |
404 | Aucune taxe n'a été trouvée |