GetTransaction

Devuelve un cobro o un pago: su cabecera, las facturas o las facturas de proveedor a las que está asignado, y sus campos de datos. Un cobro registra el dinero recibido de una entidad por sus facturas; un pago registra el dinero pagado a una entidad por sus facturas de proveedor. Utilícelo después de GetPaymentsByStatusDate para leer cada pago, por ejemplo para marcar como pagadas las facturas de proveedor en su sistema contable. Los campos son los de la página Cobro o pago.

Cómo iniciar sesión y leer la respuesta: Autenticación, Respuestas.

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

Parámetro	Obligatorio	Significado
ID	Sí	El identificador del cobro o del pago, un número entero, como ID en GetPaymentsByStatusDate. Puede ser un cobro o un pago de cualquier empresa.

Reglas

Regla	Info si no se cumple
El encabezado Token contiene un token válido.	Token missing in header, Token invalid or expired, u otra respuesta indicada en Token de inicio de sesión
El usuario es un administrador del sistema con acceso a la API.	API User must be SysAdmin with API Access
Un cobro o un pago tiene ese identificador.	No such Payment

Respuesta

Si tiene éxito, Code es 1 y RetInfo contiene tres partes: Header, List y Data. RowsAffected y Identity son 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
}

Cabecera

Campo	Significado
ID	El identificador del cobro o del pago.
Type	0 para un cobro, 1 para un pago.
Date	La Transaction Date, con el formato yyyy-MM-dd.
CurrCode	La moneda.
Amount	El importe total recibido o pagado.
Remarks	Las observaciones, o null.
Reference	La Reference, o null.
Sequence	El Sequence Number, asignado en la aprobación: el código de la empresa, el año y un número correlativo. null hasta que se aprueba.
Created, CreatedBy	Cuándo se creó, en UTC, y el identificador de usuario de quien lo creó.
Method	La Transaction Mode: cómo se recibió o se pagó el dinero.
Approved, ApprovedBy	Cuándo se aprobó, en UTC, y quién lo aprobó. null hasta que se aprueba.
EntID, EntName	El identificador y el nombre de la entidad que pagó o a la que se pagó. Consulte GetEntity.
Finalised, FinalisedBy	Cuándo se finalizó, en UTC, y quién lo finalizó. null hasta que se finaliza.

El estado se deduce de las fechas: un borrador no tiene fecha Approved, y uno aprobado no tiene fecha Finalised. Consulte Cómo avanza un cobro.

Lista

List contiene las facturas a las que está asignado un cobro, o las facturas de proveedor a las que está asignado un pago, como en su pestaña Invoices/Bills, de la más antigua a la más reciente:

Campo	Significado
ID	El identificador de la factura o de la factura de proveedor. Consulte GetInvoice y GetBill.
Number	El número de la factura o el número de factura del proveedor.
Date	La fecha de la factura o de la factura de proveedor, como fecha y hora a medianoche.
Jobs	El número de expediente: en una factura, el número de su expediente, o null en una factura que no es de un solo expediente; en una factura de proveedor, los números de los expedientes de sus partidas, separados por ; .
EntName	El nombre de la entidad de la factura o de la factura de proveedor.
CurrCode	La moneda de la factura o de la factura de proveedor.
Total	El total de la factura, o el importe facturado de la factura de proveedor, menos sus ajustes.
TaxDeduct	La retención de la factura o de la factura de proveedor.
Allocated	La parte de este cobro o pago asignada a ella.
Outstanding	Lo que queda pendiente en ella: Total menos TaxDeduct y los cobros o pagos aprobados. El propio importe Allocated de un borrador solo se tiene en cuenta una vez aprobado.

Datos

Data lista los campos de datos definidos para los cobros o para los pagos (consulte las pestañas Receipts y Payments de la página Campos de datos), cada uno con su valor en este registro:

Campo	Significado
Field	El nombre del campo.
Code	El código del campo.
CompID	Los identificadores de las empresas para las que es el campo, separados por comas, como "3,7". Vacío o null cuando es para todas las empresas.
Value	El valor, o null cuando el campo no tiene ninguno en este registro.
ValueID	En un campo que contiene una entidad o una ubicación, el identificador de la elegida. Si no, null.
Remarks	Las observaciones introducidas con el valor, o null.
Updated, UserID	Cuándo se modificó el valor por última vez, en UTC, y quién lo modificó.

Para definir estos valores, utilice SaveDataField.