Facturas (Operaciones sobre vencimientos)

Permite obtener información sobre los vencimientos de la factura y modificarlos (marcar como cobrados o pendientes de cobrar)

Recurso Descripción
GET /api/invoicePayments/#{id}.xml Devuelve información de un vencimiento identificado por el identificador #{id}
PUT /api/invoicePayments/#{id}.xml Modifica los datos de un vencimiento identificador por el identificador #{id}

GET /api/invoicePayments/#{id}.xml

Obtener una pago existente

Ejemplo para obtener un pago con id=112

curl -u 03334b0a261a2c355ae2db022a963d8e:x https://[ACCOUNT_NAME].facturadirecta.com/api/invoicePayments/112.xml

RESPUESTA SATISFACTORIA

<?xml version="1.0" encoding="UTF-8"?>
<payment>
    <id>112</id>
    <updateDate>20110409192144.235</updateDate>
    <referenceNumber><![CDATA[Referencia de ejemplo]]></referenceNumber>
    <comment><![CDATA[Comentario de ejemplo]]></comment>
    <paymentMean>02</paymentMean><!-- Recibo domiciliado -->
    <dueDate>20110613</dueDate>
    <paymentDate>20110512</paymentDate>
    <amount>30.24</amount>
</payment>

PUT /api/invoicePayments/#{id}.xml

Modificar una pago/vencimiento existente

Ejemplo para actualizar un pago/vencimiento de factura con id=112. Prácticamente todos los elementos son opcionales, y solo aquellos que estén presentes en el xml serán actualizados.

curl -u 03334b0a261a2c355ae2db022a963d8e:x -X PUT -H 'Accept: application/xml' -H 'Content-Type: application/xml'
-d "<?xml version='1.0' encoding='UTF-8'?>
<payment>
        <id>112</id>
        <referenceNumber><![CDATA[Referencia de ejemplo]]></referenceNumber>
        <comment><![CDATA[Comentario de ejemplo]]></comment>
        <paymentMean>02</paymentMean><!-- Recibo domiciliado -->
        <dueDate>20110613</dueDate>
        <paymentDate>20110512</paymentDate>
</payment>"
https://[ACCOUNT_NAME].facturadirecta.com/api/invoicePayments/112.xml

Cosas a tener en cuenta en la modificación de un pago

La modificación de un pago permitirá modificar los siguientes campos:

  • referenceNumber
  • comment
  • paymentMean
  • dueDate
  • paymentDate

Los campos amount o dueRate no serán interpretados por la API y por tanto el valor del importe del pago permanecerá igual que cuando se creó a través de la API de facturas.

Si se deseara cambiar el importe del pago, será necesario hacerlo desde los comandos de facturas /api/invoices/*

Medios de pago (paymentMean)

A continuación se muestran los códigos que pueden ser utilizados para indicar en el campo paymentMean el medio de pago del vencimiento.

Valor Descripción
01 Al contado
02 Recibo domiciliado
03 Recibo
04 Transferencia
05 Letra aceptada
06 Crédito documentario
07 Contrato adjudicación
08 Letra de cambio
09 Pagaré a la orden
10 Pagaré no a la orden
11 Cheque
12 Reposición
13 Especiales
14 Compensación
15 Giro postal
16 Cheque conformado
17 Cheque bancario
18 Pago contra reembolso
19 Pago mediante tarjeta
20 PayPal