Docs de l'API 3.1Docs de l'API 4.0 SimpleDocs de l'API 4.0

Migrer de 3.1 à 4.0

Information importante à mettre à jour de 3.1 à 4.0 de l'API.

Veuillez vous assurer d'avoir migré vers 3.1 d'abord avant de migrer vers 4.0 3.1 Guide de migration

Changements importants

POST
{base_url}/api/v4/
  • Mettre à jour les demandes à .../api/v4/... Au lieu de .../api/v3.1/... .
Valeurs monétaires
  • L'argent est maintenant envoyé et retourné en tant que nombre entier de cents. Dans la version 3.1, les mêmes champs prenaient des dollars décimaux, donc 45.99 dans la version 3.1 devient 4599 dans la version 4.0.
  • Cela s'applique généralement aux champs d'argent - totaux de facture, taxes, rabais, prix unitaires et totaux des lignes, montants de paiement, allocations, prix unitaires des articles, et à tout autre montant que vous envoyez ou recevez - pas à un seul champ.
  • Ceci est un changement silencieux : la même charge utile est acceptée dans les deux versions sans erreur, et représente un montant cent fois différent. Il est facile de se tromper dans les deux sens.
  • Envoyer des valeurs 3.1 inchangées à 4.0 facture cent fois trop peu : un 45.99 qui signifiait $45.99 est lu comme des cents et ne facture qu’environ $0.46.
  • Lire une réponse 4.0 en dollars facture cent fois trop : un 4599 retourné vaut $45.99 en cents, mais lu comme des dollars il devient $4599.00.
  • Une exception : le champ amount du point de terminaison de remboursement était déjà un nombre entier de cents en 3.1 et reste inchangé en 4.0.
    • Affectant
    • POST
      {base_url}/api/v4/site/{site_id}/invoice/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/payment/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/item/addUpdate
POST
{base_url}/api/v4/site/{site_id}/customer/addUpdate
  • Champs de contact de niveau racine ( first_name , last_name , email , mobile_phone ) doit maintenant être fourni à l'intérieur d'un primaryContact objet, ou comme entrées dans le contacts Tableau.
  • Le notification_options Champ a été supprimé. Les préférences de notification sont maintenant gérées au niveau du contact.
POST
{base_url}/api/v4/site/{site_id}/invoice/addUpdate
  • Les champs bill_email , bill_email_cc , bill_email_bcc , et billing_address ont été remplacés par le billTo Objet.
  • Le shipping_address Champ a été remplacé par le soldTo Objet.
Produits → Articles
  • Le point de terminaison Produits a été renommé en Articles. Mettez à jour les demandes vers site/{site_id}/item/addUpdate Au lieu de site/{site_id}/product/addUpdate .
    • Affectant
    • POST
      {base_url}/api/v4/site/{site_id}/item/addUpdate
Pièces jointes
  • Le attachments Champ (une liste simple d'URL) a été remplacé par le attachmentRefs Objet, qui organise les pièces jointes en internal , external , et sourcePdf Sous-champs.
    • Affectant
    • POST
      {base_url}/api/v4/site/{site_id}/invoice/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/customer/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/subscription/addUpdate
Identification de l'enregistrement
  • Dossiers sont maintenant identifiés et mis à jour par _id Au lieu de external_id .

Nouveau en 4.0

POST
{base_url}/api/v4/site/{site_id}/contact/addUpdate
  • Les contacts sont maintenant des enregistrements de première classe. Utilisez les points de terminaison des contacts pour créer, récupérer et gérer les contacts de manière indépendante des clients.
POST
{base_url}/api/v4/site/{site_id}/invoice/addUpdate
  • Un nouveau billToCustomer Champ permettant de facturer un client différent (par exemple, le parent) au lieu du client principal sur la facture.