ALalegra
Pagos

Lista de pagos

Changed on

Endpoint que retorna los pagos registrados en la cuenta de Alegra. Si no se envía límite de pagos por defecto se envían 30.

get/payments

Request

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

Query parameters

startinteger

Desde cual pago se quiere consultar. Por ejemplo para consultar desde el pago 20, se envía start=20.

limitinteger

Cantidad de pagos a partir del inicio que se desea retornar. Por defecto retorna 30 pagos. Si este valor es mayor que 30, la aplicación retorna error.

order_directionstring

Orden ascendente o descendente en el cual se quieren retornar los pagos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

order_fieldstring

Campo por el cual se desea ordenar, las opciones posibles son id, number, date, type.

typestring

Filtrar los pagos por ingresos o egresos, para ingresos se envía type como 'in', para egresos 'out'.

metadataboolean

Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los pagos. Actualmente la información que se envía en metadata incluye el total de pagos que tiene registrada la empresa. Si se envía el parámetro type retorna el total de pagos del tipo enviado.

idstring

Ids de los pagos. Sirve para consultar pagos específicos. Deben ir separados por coma (,) y sin espacios. Máximo se puede consultar un total de 30 pagos al tiempo. Si se especifica este parámetro, todos los otros parámetros serán ignorados.

client_idstring

Filtra los ingresos y/o egresos por id del cliente.

conciliation_idstring

Id de la conciliación. Permite recuperar los pagos asociados a una conciliación

includeUnconciliatedboolean

Incluye transacciones no conciliadas, debe ir junto con conciliation_id, de lo contrario se ignora este parámetro

fieldsstring

Permite recuperar campos adicionales. Se pueden incluir varios y deben ir separados por comas. Opciones disponibles: conciliation, voucherNumber (COL)

Response

Retorna la lista de pagos

Changes

  • db2f72066f99Revision changes
    • breaking

      for the query request parameter includeUnconciliated, default value false was removed

    • breaking

      for the query request parameter limit, default value 30 was removed

    • breaking

      for the query request parameter metadata, default value false was removed

    • breaking

      for the query request parameter order_direction, default value ASC was removed

    • breaking

      removed the enum value ASC from the query request parameter order_direction

    • breaking

      removed the enum value DESC from the query request parameter order_direction

    • breaking

      removed the enum value associations from the query request parameter fields

    • breaking

      removed the enum value bills from the query request parameter fields

    • breaking

      removed the enum value categories from the query request parameter fields

    • breaking

      removed the enum value conciliation from the query request parameter fields

    • breaking

      removed the enum value date from the query request parameter order_field

    • breaking

      removed the enum value debitNote 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 id from the query request parameter order_field

    • breaking

      removed the enum value in from the query request parameter type

    • breaking

      removed the enum value number from the query request parameter order_field

    • breaking

      removed the enum value numberTemplate from the query request parameter fields

    • breaking

      removed the enum value out from the query request parameter type

    • breaking

      removed the enum value type from the query request parameter order_field

    • breaking

      removed the enum value voidable from the query request parameter fields

    • info

      for the query request parameter client_id, the type was generalized from integer to string

    • info

      for the query request parameter conciliation_id, the type was generalized from integer to string

    • info

      added the non-success response with the status