ALalegra
Pagos

Consultar un pago

Changed on

Endpoint que retorna el pago registrado en la cuenta de Alegra que está identificado con el id que se envía como parámetro.

get/payments/{id}

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/payments/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Id del pago que se desea consultar. Se debe enviar en la URL.

Query parameters

account_idstring

Id de la cuenta de banco por la que se desea filtrar

conciliatedboolean

Filtrar las transacciones conciliadas o no. Por default se devuelven ambas

fieldsstring

Para obtener los comentarios del pago se debe enviar el parámetro fields con el valor comments, para obtener el voucherNumber (COL) se debe agregar el valor voucherNumber a fields.

Response

Retorna información de un pago

Changes

  • db2f72066f99Revision changes
    • breaking

      removed the enum value balance from the query request parameter fields

    • breaking

      removed the enum value billType from the query request parameter fields

    • breaking

      removed the enum value comments from the query request parameter fields

    • breaking

      removed the enum value decimalPrecision from the query request parameter fields

    • breaking

      removed the enum value deletable from the query request parameter fields

    • breaking

      removed the enum value editable from the query request parameter fields

    • breaking

      removed the enum value journal from the query request parameter fields

    • breaking

      removed the enum value number from the query request parameter fields

    • breaking

      removed the enum value numberTemplate from the query request parameter fields

    • breaking

      removed the enum value openable from the query request parameter fields

    • breaking

      removed the enum value pdf from the query request parameter fields

    • breaking

      removed the enum value regimeClient from the query request parameter fields

    • breaking

      removed the enum value simple from the query request parameter fields

    • breaking

      removed the enum value totalPayed from the query request parameter fields

    • breaking

      removed the enum value voidable from the query request parameter fields

    • info

      added the new optional query request parameter account_id

    • info

      added the new optional query request parameter conciliated

    • info

      for the path request parameter id, the type was generalized from integer to string