Consultar un pago

get https://api.alegra.com/api/v1/payments/{id}

Endpoint que permite consultar un pago registrado en la aplicación, mediante su identificador

Responses

Response body

object

integer

Identificador único que representa un pago. La aplicación lo asigna automáticamente.

bankAccount

object

Objeto cuenta de banco que indica a dónde entró o de dónde salió el dinero para el pago.

string

Identificador del banco.

name

string

Nombre del banco.

type

string

Tipo de cuenta de banco

bank cash credit-card

number

string

Número del recibo de caja o comprobante de egreso.

date

string

Fecha de pago. Formato yyyy-MM-dd.

paymentMethod

string

Método de pago

transfer cash deposit check credit-card debit-card

observations

string

Observaciones del pago. No son visibles en el documento impreso.

anotation

string

Notas del pago. Visibles en el documento impreso.

type

string

Indica si el pago es de ingreso o egreso.

status

string

Estado del pago, las opciones posibles son: open - Estado normal del pago & void - El pago se encuentra anulado.

open void

client

object

Indica el cliente asociado al pago.

string

Identificación del cliente

name

string

Nombre del cliente

phone

string

Teléfono del cliente

amount

number

Valor total asociado en el pago

bankAccountAmount

number

Valor total que ingresó a la cuenta de banco asociada. Solo se incluye este parámetro en pagos que tengan la misma moneda principal de la compañía pero que la cuenta de banco tiene una moneda diferente. Este valor se da en la moneda configurada en la cuenta de banco.

invoices

array of objects

Array de objetos factura de venta que indica la(s) factura(s) de venta que se pagaron. Todas las facturas de venta pagadas en el pago deben pertenecer al mismo cliente y deben tener la misma moneda.

invoices

object

integer

Identificador de la factura

number

string

Número de la factura

date

string

Fecha de la factura. Formato yyyy-MM-dd.

total

number

Monto total de la factura

amount

number

Valor pagado en el pago actual

bills

array of objects

Array de objetos factura de compra que indica la(s) factura(s) de compra que se pagaron. Todas las facturas de compra pagadas en el mismo pago deben ser del mismo cliente y deben tener la misma moneda.

bills

object

integer

Identificador de la factura

number

string

Número de la factura

date

string

Fecha de la factura. Formato yyyy-MM-dd.

total

number

Monto total de la factura

amount

number

Valor pagado en el pago actual

categories

object

integer

Identificador de la categoría.

name

string

Nombre de la categoría.

price

number

Valor pagado

quantity

number

Cantidad de la categoría.

observations

string

Observaciones de la categoría.

tax

array of objects

Array de objectos tax que contiene la información del impuesto de la categoría.

tax

object

integer

Identificador único que representa un impuesto específico.

name

string

Nombre asignado al impuesto

percentage

number

Porcentaje del impuesto

description

string

Descripción del impuesto

total

number

Total de la categoría (no incluye impuestos).

retentions

array of objects

Array de objetos retención que indica las retenciones aplicadas en el pago, este atributo se envía únicamente cuando el pago está asociado a categorías y se realizaron retenciones.

retentions

object

integer

Identificador de la retención

name

string

Nombre de la retención

percentage

number

Porcentaje retenido

amount

number

Valor retenido

currency

object

Objeto moneda que indica la moneda del pago y la tasa de cambio.Solo se incluye si la compañía tiene activa la funcionalidad de multimoneda y el pago está en una moneda diferente de la principal de la compañía. Este objecto contiene:code : Código ISO de la moneda asociada a la empresa.exchangeRate: Tasa de cambio.

code

string

Código ISO de la moneda asociada a la empresa

symbol

string

Símbolo de la moneda

exchangeRate

number

Tasa de cambio

appliedAdvances

array of objects

Arreglo con la información de los avances y anticipos aplicados a los pagos recibidos.

appliedAdvances

object

integer

Identificador de la factura de los avances y anticipos aplicados

number

string

Número de la factura de los avances y anticipos aplicados

date

string

Fecha de creación de la factura de los avances y anticipos aplicados

dueDate

string

Fecha de vencimiento de la factura de los avances y anticipos aplicados

total

number

Total de la factura de los avances y anticipos aplicados

totalPaid

number

Total que se le ha pagado a una factura sin contar retenciones, de la factura de los avances y anticipos aplicados

balance

number

Monto que indica el valor pendiente para terminar de pagar la factura

amount

number

Monto que indica el total de anticipos aplicados a la factura

costCenter

object

Objeto costCenter que indica el centro de costo asociado al pago.

integer

Identificador del centro de costo

code

string

Código del centro de costo

name

string

Nombre del centro de costo

description

string

Descripción del centro de costo

status

boolean

Estatus del centro de costo (activo o inactivo)

voucherNumber (Colombia)

string

Indica el número del recibo de caja, valido solo para operaciones de tipo IN.Solo para Colombia

comments

array

Arreglo comments con la información de cada uno de los comentarios del pago.

comments

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.alegra.com/api/v1/payments/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Se obtiene un objeto que describe un pago

404No se ha encontrado el pago con el identificador especificado