# Listar Formas de Pago Permite obtener las formas de pago configuradas de la inmobiliaria. Solo devuelve las formas de pago que tengan una cuenta contable (PUC) relacionada. **Endpoint:** https://***{{instancia}}***.arrendasoft.co/service/v2/public/invoices/payment-methods **{{instancia}}:** Hace referencia a la instancia de cada inmobiliaria. #### **Petición**
**Método**GET
**Content-Type**application/json
**Authorization****Bearer token**, Token obtenido al consumir el servicio [Login](https://docs.nuby.ai/books/api-nuby-v2/page/login)
**Parámetros**
**Parámetro****Tipo****Obligatorio****Valor por defecto****Descripción**
codigo\_dianstringNo-Filtra formas de pago por el código DIAN del medio de pago (ej: 42 para Consignación bancaria).
cuenta\_pucstringNo-Filtra formas de pago por código de cuenta PUC. La búsqueda es por prefijo (ej: 1110 retorna todas las cuentas que inicien con ese código).
**Ejemplos de peticiones** ``` https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/payment-methods ``` ``` https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/payment-methods?codigo_dian=42 ``` ``` https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/payment-methods?cuenta_puc=1110 ``` ``` https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/payment-methods?codigo_dian=42&cuenta_puc=1110 ``` #### **Respuesta** Lista de formas de pago configuradas con información del medio de pago DIAN y cuenta contable asociada. ```json { "success": true, "status": 200, "message": null, "body": [ { "formaPagoId": 1, "nombre": "Consignación Bancolombia", "cuentaPuc": "11100501", "codigoDian": "42", "medioPago": "Consignación bancaria" }, { "formaPagoId": 2, "nombre": "Transferencia Davivienda", "cuentaPuc": "11100502", "codigoDian": "31", "medioPago": "Transferencia débito bancaria" }, { "formaPagoId": 3, "nombre": "Pago con tarjeta de crédito", "cuentaPuc": "11100503", "codigoDian": "48", "medioPago": "Tarjeta de crédito" } ], "filters_applied": null } ``` ##### Claves y Descripciones del JSON de Respuesta Esta tabla enumera las claves presentes en el JSON principal de la respuesta y proporciona una breve descripción de cada una.
**Clave****Tipo****Descripción**
`success`BooleanoIndica si la operación fue exitosa (true) o fallida (false).
`status`EnteroCódigo HTTP de la respuesta: 200 para exitoso, 500 para error interno.
`message`TextoMensaje descriptivo. Es nulo cuando hay resultados, o contiene un mensaje informativo cuando no se encontraron formas de pago.
`body`ArrayContiene el listado de formas de pago. Es un array vacío si no hay resultados.
`filters_applied`ObjetoContiene los filtros que fueron aplicados en la consulta. Es nulo si no se aplicaron filtros.
##### Cuerpo Cada elemento dentro de la lista `body` tiene las siguientes claves:
**Clave****Tipo****Descripción**
`formaPagoId`EnteroIdentificador único de la forma de pago. Use este valor para el parámetro `forma\_pago\_id` al registrar un pago.
`nombre`TextoNombre descriptivo de la forma de pago configurada por la inmobiliaria.
`cuentaPuc`TextoCódigo de la cuenta contable (PUC) asociada a la forma de pago.
`codigoDian`TextoCódigo del medio de pago según la clasificación DIAN.
`medioPago`TextoNombre del medio de pago según la clasificación DIAN.
##### Filtros Aplicados El objeto `filters_applied` contiene los filtros que fueron utilizados en la consulta. Solo se incluye en la respuesta cuando se aplican filtros. Las posibles claves son:
**Clave****Tipo****Descripción**
`codigo_dian`TextoCódigo DIAN del medio de pago utilizado como filtro.
`cuenta_puc`TextoCódigo de cuenta PUC utilizado como filtro (búsqueda por prefijo).
#### **Respuesta con Filtros Aplicados** ```json { "success": true, "status": 200, "message": null, "body": [ { "formaPagoId": 1, "nombre": "Consignación Bancolombia", "cuentaPuc": "11100501", "codigoDian": "42", "medioPago": "Consignación bancaria" } ], "filters_applied": { "codigo_dian": "42" } } ``` #### **Respuesta Sin Resultados** ```json { "success": true, "status": 200, "message": "No se encontraron formas de pago con los criterios especificados.", "body": [], "filters_applied": { "codigo_dian": "99" } } ``` #### **Respuesta de Error** ##### Error Interno (500) Se retorna cuando ocurre un error inesperado en el servidor. ```json { "success": false, "status": 500, "message": "Error interno del servidor al obtener las formas de pago.", "body": null, "filters_applied": null } ``` #### **Códigos de Respuesta HTTP**
**Código****Descripción**
200Consulta exitosa. El cuerpo de la respuesta contiene las formas de pago (puede ser un array vacío si no hay resultados).
500Error interno del servidor.
#### **Códigos DIAN de Medios de Pago** Referencia de códigos DIAN comunes para medios de pago:
CódigoMedio de Pago
10Efectivo
31Transferencia Débito
42Consignación bancaria
47Transferencia Débito Bancaria
48Tarjeta Crédito
49Tarjeta Débito
Para consultar el listado completo de códigos de medios de pago, visite la [Documentación Técnica de Factura Electrónica - DIAN](https://www.dian.gov.co/impuestos/factura-electronica/documentacion/Paginas/documentacion-tecnica.aspx). #### **Notas Importantes**
1. **Solo formas de pago configuradas:** Este endpoint solo retorna las formas de pago que tengan una cuenta contable (PUC) asociada. Las formas de pago sin cuenta contable no aparecerán en los resultados. 2. **Uso con registro de pagos:** El `formaPagoId` retornado puede usarse como valor del parámetro `forma_pago_id` en el endpoint [Registrar Pago de Factura](https://docs.nuby.ai/books/api-nuby-v2/page/registrar-pago-de-factura "Registrar Pago de Factura"). 3. **Búsqueda por cuenta PUC:** El filtro `cuenta_puc` realiza una búsqueda por prefijo, lo que permite filtrar por grupos de cuentas (ej: `1110` retorna todas las cuentas PUC que inicien con ese código).
#### **Ejemplos**
Curl ```bash curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/payment-methods" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_AUTHENTICATION_TOKEN" ``` **Con filtros:** ```bash curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/payment-methods?codigo_dian=42" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_AUTHENTICATION_TOKEN" ```
PHP Curl ```php ```
JavaScript Fetch ```javascript const instance = 'your_instance'; // Reemplace con su instancia actual const token = 'YOUR_AUTHENTICATION_TOKEN'; // Reemplace con el token obtenido // Parámetros de filtro opcionales const params = new URLSearchParams(); // params.append('codigo_dian', '42'); // Opcional: descomentar para filtrar // params.append('cuenta_puc', '1110'); // Opcional: descomentar para filtrar const url = `https://${instance}.arrendasoft.co/service/v2/public/invoices/payment-methods${params.toString() ? '?' + params.toString() : ''}`; fetch(url, { method: 'GET', headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${token}` } }) .then(response => response.json()) .then(data => { if (data.success && data.body.length > 0) { console.log(`Se encontraron ${data.body.length} formas de pago:`); data.body.forEach(formaPago => { console.log(`- ${formaPago.nombre} (ID: ${formaPago.formaPagoId})`); console.log(` Cuenta PUC: ${formaPago.cuentaPuc}`); console.log(` Medio DIAN: ${formaPago.medioPago} (${formaPago.codigoDian})`); }); } else { console.log(data.message || 'No se encontraron formas de pago.'); } }) .catch(error => console.error('Error de conexión:', error)); ```