Arguments

Aperçu

Les arguments sont composés d'attributs, d'opérateurset devaleurs. Ils peuvent être ajoutés à n'importe quelle demande pour limiter les résultats, les attributs disponibles sont énumérés dans la documentation détaillée de chaque objet commercial. Coupa prend en charge un certain nombre d'opérateursen plus de la correspondance exacte/d'égalité par défaut.

Format de demande général

<url>?<attribute><[operator]>=<value>&...

Le premier exemple renvoie les 50 premiers fournisseurs actifs commençant par id=1.  Le deuxième exemple renvoie les 50 premiers bons de commande dont la date de mise à jour est supérieure ou égale à la date spécifiée.

Exemple :

https://example.coupahost.com/api/suppliers?status=active
https://example.coupahost.com/api/purchase_orders?updated_at[gt_or_eq]=2010-12-31

Limite et décalage

Vous pouvez utiliser des paramètres de limite et de décalage pour paginer les résultats.  N'oubliez pas que le nombre maximum de résultats renvoyés est de 50 à la fois.

Exemple : Pour obtenir les 150 premiers bons de commande :

https://example.coupahost.com/api/purchase_orders
https://example.coupahost.com/api/purchase_orders?offset=50
https://example.coupahost.com/api/purchase_orders?offset=100

Recherche dans une collection

Pour les collections d'éléments, telles que les lignes de commande dans ce cas, utilisez la forme plurielle et ignorez la forme singulière imbriquée.

Exemple :

<order-header>
   <order-lines>
      <order-line>
         <account>
            <code>a-c</code>
         </account>
      </order-line>
   </order-lines>
</order-header>

Devient :

https://example.coupahost.com/api/purchase_orders?order-lines[account][code]=a-c

Soulignements

Lorsque vous utilisez des éléments de ressources dans vos arguments, les tirets doivent être convertis en traits de soulignement.

Exemple :

<exchange-rate>
   <from-currency>
      <code>USD</code>
      <id type="integer">1</id>
   </from-currency>
</exchange-rate>

Devient :

https://example.coupahost.com/api/exchange_rates?from_currency_id=1