Créer un paiement avec l'API FreshBooks

Enregistre un paiement reçu sur une facture, comme un virement ou des espèces, et le renvoie dans result.payment. Les champs vont dans payment, avec invoiceid et amount. La facture passe en partielle ou payée selon le montant.

Identifiant
freshbooks_create_payment

L'appel

POST https://connect.reportei.com/api/tools/freshbooks_create_payment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": "<account_id>",
    "payment": {}
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
account_idstringOuiaccount_id of a business, from Get current user.
paymentobjectOuiThe payment received.

Connexions possibles

Votre client connecte son compte FreshBooks une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/freshbooks, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/freshbooks_create_payment. Il devient la définition de tool de votre agent sans conversion.

Autres tools FreshBooks

Voir les 14 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.