Pagos

Endpoint que permite editar un pago en la aplicación. Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos. Se retorna el pago que se ha modificado.

Por ejemplo para editar la fecha de creación de un pago se debe enviar el siguiente JSON: {"date" : "2016-06-27"} Para eliminar algún dato del pago enviar el atributo en null, así: {"observations" : null}

Se debe tener en cuenta que el tipo del pago no puede se modificado, es decir, un pago tipo in, no puede editarse a tipo out.

put/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 editar. Se debe enviar en la URL.

Request body

OR
OR

Example request

{
  "date": "2022-10-30"
}

Response

Retorna un objeto con la información del pago

Changes

    • breaking

      added the new path request parameter id

    • breaking

      removed subschema #1: Pago subschema #2 subschema #3 from the request body oneOf list

    • breaking

      the request's body type changed from object to no type

    • info

      added to the request body oneOf list

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status