Avant de commencer
API pour les factures
L'API Affise vous fournit différentes méthodes pour travailler avec les factures. Par exemple, vous pouvez obtenir des informations sur les factures de paiement, créer une facture de paiement, la supprimer, etc. Dans cet article, vous trouverez des exemples des requêtes (méthodes) d'API les plus populaires pour les facturations avec des exemples cURL et des exemples de réponse.
💰 La fonctionnalité de facturation via API n'est disponible que pour certains plans. Contactez votre gestionnaire de compte Affise pour obtenir cette fonctionnalité.
Obtenir la liste des paiements
Utilisez cette méthode pour obtenir la liste des paiements en fonction de leurs propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: GET /3.1/payments.
La requête pour obtenir la liste des paiements avec la période spécifiée :
https://api-rocketcompany.affise.com/3.1/payments?date_from=2022-08-08&date_to=2022-12-12
Créer une facture de paiement
Utilisez cette méthode pour générer la facture d'une certaine somme d'argent pour un certain affilié en fonction de ses propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: POST /3.1/payments/create-for-affiliate.
La requête cURL pour la création d'une facture de paiement avec les propriétés suivantes :
l'ID de l'affilié
le montant de la facture de paiement
l'identifiant de la devise
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/create-for-affiliate' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'api-key : 5c9f6bbe709c5b331a9630b1fb1db0ed' \N---header 'Cookie : PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \N---data-urlencode 'aid=2' \N---data-urlencode 'sum=2' \N---data-urlencode 'currency=150'
Générer des factures de paiement pour les affiliés
Utilisez cette méthode pour générer la facturation pour une certaine période en fonction de ses propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: POST /3.1/payments/generate.
La requête cURL pour la création d'une facture de paiement pour les affiliés avec les propriétés suivantes :
la date
l'ID de l'affilié
l'ID de l'affilié exclu
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/generate' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'api-key : 5c9f6bbe709c5b331a9630b1fb1db0ed' \N---header 'Cookie : PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \N---data-urlencode 'date=2022-05-23' \N---data-urlencode 'aid=2' \N---data-urlencode 'exclude_aids[]=8'
Mise à jour de la facture de paiement
Utilisez cette méthode pour mettre à jour la facture de paiement en fonction de ses propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: POST /3.1/payments/{ID}.
La requête cURL pour la mise à jour de la facture de paiement avec les propriétés suivantes :
les informations sur le compte de paiement
le statut "Paid partly" (payé en partie)
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2926' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'api-key : 5c9f6bbe709c5b331a9630b1fb1db0ed' \N---header 'Cookie : PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \N---data-urlencode 'payment_account=compte de paiement' \N---data-urlencode 'status=3'
Ajout d'une valeur de correction pour une facture de paiement
Utilisez cette méthode pour ajouter une valeur de correction à la facture de paiement en fonction de ses propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: POST /3.1/payments/{ID}/add-correction.
La requête cURL pour l'ajout d'une valeur de correction avec les propriétés suivantes :
le revenu = 22
le commentaire
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2921/add-correction' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'api-key : 5c9f6bbe709c5b331a9630b1fb1db0ed' \N---header 'Cookie : PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \N---data-urlencode 'revenue=22' \N---data-urlencode 'comment=example'
Supprimer plusieurs factures de paiement
Utilisez cette méthode pour supprimer plusieurs factures de paiement en fonction de leurs propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: POST /3.1/payments/bulk-delete.
⚠️ Vous pouvez supprimer la facturation avec n'importe quel statut, sauf Complete. Si vous essayez de supprimer la facture avec le statut Complete, vous obtenez l'erreur suivante :
La requête cURL pour plusieurs factures de paiement a été supprimée avec les identifiants de factures de paiement = 2925 et 2924 :
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/bulk-delete' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'api-key : 5c9f6bbe709c5b331a9630b1fb1db0ed' \N---header 'Cookie : PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \N---data-urlencode 'ids[0]=2925' \N---data-urlencode 'ids[1]=2924'
Modifier les systèmes de paiement
Utilisez cette méthode pour modifier les systèmes de paiement d'un affilié en fonction de leurs propriétés, que vous pouvez indiquer dans votre demande API.
La méthode: POST /3.0/admin/partner/{ID}.
⚠️ L'option de modification n'est disponible que si la facturation a un statut quelconque, sauf Complet.
La requête cURL pour éditer les systèmes de paiement avec affiliates systems ID = 13, currency code = USD, et advanced fields = 1b765 :
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/partner/2' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'api-key : 5c9f6bbe709c5b331a9630b1fb1db0ed' \N---header 'Cookie : PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \N---data-urlencode 'payment_systems[0][system_id]=13' \N---data-urlencode 'payment_systems[0][currency]=USD' \N---data-urlencode 'payment_systems[0][fields][4]=1b765'
Veuillez contacter l'équipe d'assistance à la clientèle d'Affise pour toutes les questions soulevées par le biais de l'e-mail : [email protected].