GetTransaction

Renvoie un encaissement ou un paiement : son en-tête, les factures ou les factures fournisseurs auxquelles il est affecté, et ses champs de données. Un encaissement enregistre de l’argent reçu d’une entité en règlement de ses factures ; un paiement enregistre de l’argent versé à une entité en règlement de ses factures fournisseurs. Utilisez-le après GetPaymentsByStatusDate pour lire chaque paiement, par exemple pour marquer comme payées les factures fournisseurs dans votre système comptable. Les champs sont ceux de la page Encaissement ou paiement.

Comment se connecter et lire la réponse : Authentification, Réponses.

GET /api/v1/GetTransaction?ID=60218
Token: your-token

Paramètre	Obligatoire	Signification
ID	Oui	L’identifiant de l’encaissement ou du paiement, un nombre entier, comme ID dans GetPaymentsByStatusDate. Il peut s’agir d’un encaissement ou d’un paiement de n’importe quelle société.

Règles

Règle	Info en cas d’échec
L’en-tête Token contient un jeton valide.	Token missing in header, Token invalid or expired, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système avec l’accès à l’API.	API User must be SysAdmin with API Access
Un encaissement ou un paiement a cet identifiant.	No such Payment

Réponse

En cas de succès, Code vaut 1 et RetInfo contient trois parties : Header, List et Data. RowsAffected et Identity valent 0.

{
  "Code": 1,
  "Info": "",
  "RetInfo": {
    "Header": {
      "ID": 60218,
      "Type": 1,
      "Date": "2026-10-06",
      "CurrCode": "USD",
      "Amount": 1150.00,
      "Remarks": null,
      "Reference": "TRF-88412",
      "Sequence": "HQ20260012",
      "Created": "2026-10-06T08:02:37.4",
      "CreatedBy": "jsmith",
      "Method": "Bank Transfer",
      "Approved": "2026-10-06T10:45:12.13",
      "ApprovedBy": "jsmith",
      "EntID": 2214,
      "EntName": "Example Shipping Co",
      "Finalised": null,
      "FinalisedBy": null
    },
    "List": [
      {
        "ID": 109827,
        "Number": "INV-2026-0042",
        "Date": "2026-10-01T00:00:00",
        "Jobs": "JOB-2610-0021; JOB-2610-0034",
        "EntName": "Example Shipping Co",
        "CurrCode": "USD",
        "Total": 1150.00,
        "TaxDeduct": 0.00,
        "Allocated": 1150.00,
        "Outstanding": 0.00
      }
    ],
    "Data": [
      {
        "Field": "Bank Reference",
        "Code": "BANKREF",
        "CompID": null,
        "Value": "TRF-88412",
        "ValueID": null,
        "Remarks": null,
        "Updated": "2026-10-06T08:03:10.22",
        "UserID": "jsmith"
      }
    ]
  },
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 0
}

En-tête

Champ	Signification
ID	L’identifiant de l’encaissement ou du paiement.
Type	0 pour un encaissement, 1 pour un paiement.
Date	La Transaction Date, au format yyyy-MM-dd.
CurrCode	La devise.
Amount	Le montant total reçu ou versé.
Remarks	Les remarques, ou null.
Reference	La Reference, ou null.
Sequence	Le Sequence Number, attribué lors de l’approbation : le code de la société, l’année et un numéro d’ordre. null jusqu’à l’approbation.
Created, CreatedBy	Le moment de la création, en UTC, et l’identifiant utilisateur de la personne qui l’a effectuée.
Method	Le Transaction Mode : la façon dont l’argent a été reçu ou versé.
Approved, ApprovedBy	Le moment de l’approbation, en UTC, et la personne qui l’a effectuée. null jusqu’à l’approbation.
EntID, EntName	L’identifiant et le nom de l’entité qui a payé ou qui a été payée. Voir GetEntity.
Finalised, FinalisedBy	Le moment de la finalisation, en UTC, et la personne qui l’a effectuée. null jusqu’à la finalisation.

Le statut découle des dates : un brouillon n’a pas de date Approved, et un encaissement ou un paiement approuvé n’a pas de date Finalised. Voir Les étapes d’un encaissement.

Liste

List contient les factures auxquelles un encaissement est affecté, ou les factures fournisseurs auxquelles un paiement est affecté, comme dans son onglet Invoices/Bills, de la plus ancienne à la plus récente :

Champ	Signification
ID	L’identifiant de la facture ou de la facture fournisseur. Voir GetInvoice et GetBill.
Number	Le numéro de la facture ou le numéro de facture du fournisseur.
Date	La date de la facture ou de la facture fournisseur, sous forme de date et heure à minuit.
Jobs	Le numéro de dossier : pour une facture, le numéro de son dossier, ou null pour une facture qui ne concerne pas un seul dossier ; pour une facture fournisseur, les numéros des dossiers de ses postes, séparés par ; .
EntName	Le nom de l’entité de la facture ou de la facture fournisseur.
CurrCode	La devise de la facture ou de la facture fournisseur.
Total	Le total de la facture, ou le montant facturé de la facture fournisseur, moins ses ajustements.
TaxDeduct	La retenue à la source sur la facture ou la facture fournisseur.
Allocated	La part de cet encaissement ou de ce paiement qui lui est affectée.
Outstanding	Ce qui reste dû : Total moins TaxDeduct et les encaissements ou paiements approuvés. Le montant Allocated d’un brouillon n’est pris en compte qu’une fois celui-ci approuvé.

Données

Data liste les champs de données configurés pour les encaissements ou pour les paiements (voir les onglets Receipts et Payments des champs de données), chacun avec la valeur de cet enregistrement :

Champ	Signification
Field	Le nom du champ.
Code	Le code du champ.
CompID	Les identifiants des sociétés auxquelles le champ est destiné, séparés par des virgules, comme "3,7". Vide ou null lorsqu’il est destiné à toutes les sociétés.
Value	La valeur, ou null lorsque le champ n’en a pas sur cet enregistrement.
ValueID	Pour un champ qui contient une entité ou un lieu, l’identifiant de celui qui a été choisi. Sinon null.
Remarks	Les remarques saisies avec la valeur, ou null.
Updated, UserID	Le moment de la dernière modification de la valeur, en UTC, et la personne qui l’a effectuée.

Pour définir ces valeurs, utilisez SaveDataField.