API des lignes budgétaires (/lignes budgétaires)
Utilisez l'API de ligne budgétaire pour créer et mettre à jour les lignes budgétaires que vous avez associées à vos comptes.
Utilisez l'API de ligne budgétaire pour créer et mettre à jour les lignes budgétaires que vous avez associées à vos comptes.
L'URL pour accéder aux lignes budgétaires est : https ://<instance>/API/lignes budgétaires
Voir les meilleures pratiques d'intégration pour plus d'informations.
Remarque
- Si vous soumettez cette API en utilisant une période budgétaire statique basée sur un plan comptable, toutes les valeurs de segment incluses doivent provenir d'un compte existant.
- Si vous soumettez cette API à l'aide d'un plan comptable dynamique, toutes les valeurs de segment incluses doivent correspondre aux segments de compte existants ou aux valeurs de recherche. Cette API ne crée pas directement le compte.
Actions
L'API des lignes budgétaires vous permet de :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| METTRE | /api/budget_lines/:id/ajuster |
ajuster | Créer un ajustement de ligne budgétaire pour la ligne budgétaire |
| PUBLIER | /api/budget_lines |
créer | Créer une ligne budgétaire |
| OBTENIR | /api/budget_lines |
index | Recherche de lignes budgétaires |
| OBTENIR | /api/budget_lines/:id |
afficher | Afficher la ligne du budget |
| METTRE | /api/budget_lines/:id |
mettre à jour | Actualiser la ligne du budget |
Éléments
Les éléments suivants sont disponibles pour l'API des lignes budgétaires :
| Élément | Description | Champ obligatoire ? | Unique ? | Valeur autorisée | Api_In Field ? | Api_Out Field ? | Type de données |
|---|---|---|---|---|---|---|---|
| montant | montant | oui | décimale | ||||
| created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| créé par | Utilisateur qui a créé | oui | Utilisateur | ||||
| devise | Devise de la transaction | oui | oui | Devise | |||
| description | description | oui | oui | chaîne | |||
| error-on-overrun | Empêcher la soumission de demandes qui dépasseraient le budget | oui | oui | boolean | |||
| iD | Identifiant unique Coupa | oui | nombre entier | ||||
| notes | notes | oui | oui | texte | |||
| calcul du dépassement | calcul_dépassement | oui | oui | nombre entier | |||
| responsable | responsable du budget | oui | oui | Utilisateur | |||
| owner-is-approver | Le propriétaire est un approbateur ? | oui | oui | nombre entier | |||
| pending_requisitions_amount | Montant consommé par les demandes en attente | oui | décimale | ||||
| period | C'est le surnom de la ligne budgétaire. Les utilisateurs peuvent afficher et rechercher dans ce champ via l'interface utilisateur. | oui | oui | oui | Période | ||
| restants | restants | oui | décimale | ||||
| remaining-budget | Budget restant | oui | décimale | ||||
| segment-1 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-10 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-11 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-12 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-13 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-14 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-15 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-16 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-17 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-18 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-19 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-2 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-20 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-3 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-4 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-5 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-6 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-7 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-8 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| segment-9 | Fournissez éventuellement chaque segment individuellement. Ceci est requis si l'un des segments contient le caractère tiret "-", ce qui empêche le code de segment de budgétisation d'être divisé automatiquement | oui | oui | chaîne | |||
| set-amount-from-xml | set_amount_from_xml | oui | |||||
| mis-à-jour à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| mis à jour par | Utilisateur ayant réalisé la mise à jour | oui | Utilisateur |
Remarque
- Pour un ensemble de données volumineux et une optimisation des performances, limitez toujours votre résultat avec certains critères GET.
- Vous pouvez utiliser POST pour créer de nouvelles lignes budgétaires pour les périodes budgétaires existantes et les segments de compte existants (c'est-à-dire segment-1, segment-2, etc.). Cela signifie que vous ne pouvez pas créer de nouvelles périodes budgétaires à l'aide de l'API.
- Une fois la ligne budgétaire créée et associée à un type de compte (c'est-à-dire un plan comptable) et à un compte spécifique, vous ne pouvez pas modifier ces informations.