Contribuyentes
Maneja todas las operaciones CRUD para los contribuyentes en la API.
Endpoints
Section titled “Endpoints”Obtener todos los contribuyentes
Section titled “Obtener todos los contribuyentes”GET /taxpayers
Parámetros de consulta:
query
: Parámetros de filtrado y ordenamiento (opcional)
[ { "id": "69f1166f-8372-4562-9344-ed71594fd9a5", "deletedAt": null, "createdAt": "2025-06-04T17:04:02.680Z", "updatedAt": "2025-06-04T17:04:02.680Z", "ruc": "0993154789001", "name": "Nombre del contribuyente", "commercialName": "Nombre comercial", "address": "Dirección del contribuyente", "accountingObligated": true, "specialContributorCode": "123456789", "environment": "1", "uuidFileP12": "9bb7f0b3-aa1c-4eb7-b5eb-78688494e8e8", "logoUrl": "www.ejemplo.com/logo", "tenantId": "e60afaa5-c598-4390-a3d8-2db4665aa9cc" }]
Filtros
Section titled “Filtros”Campo | Operador | Ejemplo |
---|---|---|
name | like | GET /taxpayers?query=filter.name__like=empresa |
ruc | eq | GET /taxpayers?query=filter.ruc__eq=0993154789001 |
commercialName | like | GET /taxpayers?query=filter.commercialName__like=abc |
Obtener un contribuyente por ID
Section titled “Obtener un contribuyente por ID”GET /taxpayers/{id}
Parámetros de URL:
id
: ID del contribuyente a buscar
{ "id": "69f1166f-8372-4562-9344-ed71594fd9a5", "deletedAt": null, "createdAt": "2025-06-04T17:04:02.680Z", "updatedAt": "2025-06-04T17:04:02.680Z", "ruc": "0993154789001", "name": "Nombre del contribuyente", "commercialName": "Nombre comercial", "address": "Dirección del contribuyente", "accountingObligated": true, "specialContributorCode": "123456789", "environment": "1", "uuidFileP12": "9bb7f0b3-aa1c-4eb7-b5eb-78688494e8e8", "logoUrl": "www.ejemplo.com/logo", "tenantId": "e60afaa5-c598-4390-a3d8-2db4665aa9cc"}
Actualizar un contribuyente existente
Section titled “Actualizar un contribuyente existente”PUT /taxpayers/{id}
Parámetros de URL:
id
: ID del contribuyente a actualizar
{ "ruc": "0993154789001", "name": "Nuevo nombre del contribuyente", "commercialName": "Nuevo nombre comercial", "address": "Nueva dirección", "accountingObligated": false, "specialContributorCode": "987654321", "uuidLogo": "nuevo-uuid-logo", "userId": "https://ejemplo.com/usuario-nuevo", "tenantId": "uuid-tenant", "signaturePassword": "nueva-contraseña-firma"}
{ "id": "69f1166f-8372-4562-9344-ed71594fd9a5", "deletedAt": null, "createdAt": "2025-06-04T17:04:02.680Z", "updatedAt": "2025-06-04T17:04:32.120Z", "ruc": "0993154789001", "name": "Nuevo nombre del contribuyente", "commercialName": "Nuevo nombre comercial", "address": "Nueva dirección", "accountingObligated": false, "specialContributorCode": "987654321", "environment": "1", "uuidFileP12": "9bb7f0b3-aa1c-4eb7-b5eb-78688494e8e8", "logoUrl": "www.ejemplo-nuevo.com/logo", "tenantId": "e60afaa5-c598-4390-a3d8-2db4665aa9cc"}
Eliminar un contribuyente
Section titled “Eliminar un contribuyente”DELETE /taxpayers/{id}
Parámetros de URL:
id
: ID del contribuyente a eliminar
{ "id": "69f1166f-8372-4562-9344-ed71594fd9a5", "deletedAt": null, "createdAt": "2025-06-04T17:04:02.680Z", "updatedAt": "2025-06-04T17:04:02.680Z", "ruc": "324242-Deletedhtih", "name": "fdsdf", "commercialName": "sfdsf", "address": "dfgdfgd", "accountingObligated": true, "specialContributorCode": "424234324", "environment": "1", "uuidFileP12": "9bb7f0b3-aa1c-4eb7-b5eb-78688494e8e8", "signaturePassword": "2342sdfdfsf", "logoUrl": "www.google.com", "tenantId": "e60afaa5-c598-4390-a3d8-2db4665aa9cc"}