{ "item": [ { "name": "v1", "description": "", "item": [ { "name": "developer", "description": "", "item": [ { "name": "invoices", "description": "", "item": [ { "id": "f443d90e-ed78-49d8-957e-df12a2254736", "name": "Emitir comprobante electrónico", "request": { "name": "Emitir comprobante electrónico", "description": { "content": "Modo A — flujo completo: crea el XML, lo firma con tu certificado P12, lo autoriza ante el SRI, genera el PDF (RIDE) y envía el correo al cliente automáticamente.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "303dbeaf-9bd1-45fb-85b1-6c9a02bf6aa9", "name": "Resource created successfully", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"paymentMethod\": \"01\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"accessKey\": \"\",\n \"sequential\": \"\",\n \"status\": \"\",\n \"total\": \"\",\n \"source\": \"\",\n \"apiKeyId\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "831b6f6c-e416-47b2-bd0d-463b07dc7b06", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"paymentMethod\": \"01\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53bffdb0-2789-4d83-9477-fb44de470d29", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"paymentMethod\": \"01\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf14cae4-3cb8-48b0-a699-25869e9a9c44", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"paymentMethod\": \"01\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b0ac9e5-914c-46fc-89ff-4939504ad55e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"paymentMethod\": \"01\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f9d25c1-1ccc-4342-8792-2c456a2c4c68", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"customerId\": \"\",\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"saveToContacts\": \"\"\n },\n \"items\": [\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"NO_TAX\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n },\n {\n \"quantity\": \"\",\n \"productId\": \"\",\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"discount\": \"\",\n \"taxType\": \"IVA_0\",\n \"tax\": \"\",\n \"saveToProducts\": \"\"\n }\n ],\n \"emissionPointId\": \"\",\n \"establishment\": \"\",\n \"emissionPoint\": \"\",\n \"paymentMethod\": \"01\",\n \"payments\": [\n {\n \"method\": \"01\",\n \"amount\": \"\",\n \"term\": 0,\n \"timeUnit\": \"dias\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Listar facturas", "request": { "name": "Listar facturas", "description": { "content": "Lista las facturas emitidas con paginación. Puedes filtrar por RUC del cliente, estado y rango de fechas.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ruc", "value": "", "description": "RUC o cédula del cliente (filtro opcional)", "disabled": true }, { "key": "status", "value": "", "description": "Estado: DRAFT | AUTHORIZED | REJECTED | VOIDED", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Fecha de inicio ISO 8601 (ej: 2025-01-01)", "disabled": true }, { "key": "dateTo", "value": "", "description": "Fecha de fin ISO 8601 (ej: 2025-12-31)", "disabled": true }, { "key": "page", "value": "1", "description": "Número de página (default: 1)" }, { "key": "limit", "value": "20", "description": "Resultados por página (default: 20, max: 100)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"accessKey\": \"\",\n \"sequential\": \"\",\n \"status\": \"AUTHORIZED\",\n \"total\": \"\",\n \"issueDate\": \"\",\n \"createdAt\": \"\",\n \"customer\": {\n \"identification\": \"\",\n \"identificationType\": \"RUC\",\n \"legalName\": \"\"\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"page\": 1,\n \"limit\": 20,\n \"totalPages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Obtener factura", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/developer/receipts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "developer", "receipts", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la factura" } ] }, "description": "Retorna el detalle completo de una factura por su ID." } }, { "name": "Estado de la factura", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/developer/receipts/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "developer", "receipts", ":id", "status" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la factura" } ] }, "description": "Consulta el estado SRI (DRAFT, AUTHORIZED, REJECTED, VOIDED) de una factura." } }, { "name": "Descargar XML de factura", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/developer/receipts/:id/xml", "host": [ "{{baseUrl}}" ], "path": [ "v1", "developer", "receipts", ":id", "xml" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la factura" } ] }, "description": "Descarga el XML autorizado de la factura." } }, { "name": "Descargar PDF de factura", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/developer/receipts/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "developer", "receipts", ":id", "pdf" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la factura" } ] }, "description": "Descarga el RIDE (PDF) de la factura." } }, { "name": "Anular factura", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{baseUrl}}/v1/developer/receipts/:id/void", "host": [ "{{baseUrl}}" ], "path": [ "v1", "developer", "receipts", ":id", "void" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la factura" } ] }, "description": "Anula una factura autorizada." } }, { "name": "import", "description": "", "item": [ { "id": "ced58bd5-125b-4e01-9950-f55d58fbd344", "name": "Importar comprobante por clave de acceso", "request": { "name": "Importar comprobante por clave de acceso", "description": { "content": "Importa una factura ya autorizada por el SRI usando su clave de acceso de 49 dígitos. Útil para sincronizar comprobantes emitidos fuera de Factuplan.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0201d969-f848-442b-ae1d-391f14de0d2c", "name": "Resource created successfully", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"accessKey\": \"\",\n \"sequential\": \"\",\n \"status\": \"\",\n \"total\": \"\",\n \"source\": \"\",\n \"apiKeyId\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c358efc-8b7b-4c04-bdc0-efd2e9a95a2f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "741ba138-4d0d-4955-bd42-1ee78054d545", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff0fd6b4-13e1-455d-96e4-efbcd880cb42", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebbc3b9f-4898-4e2d-9852-af4cfcc277f8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aff4930-1cce-4478-8c64-951544b7b765", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "invoices", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Actualizar secuencial de facturas", "request": { "method": "PATCH", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"branchCode\": \"001\",\n \"emissionCode\": \"001\",\n \"invoiceSequential\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/developer/invoices/sequential", "host": [ "{{baseUrl}}" ], "path": [ "v1", "developer", "invoices", "sequential" ] }, "description": "Establece el próximo número secuencial para facturas en el punto de emisión indicado. El nuevo valor entra en efecto en el siguiente comprobante emitido." }, "response": [] } ] }, { "name": "usage", "description": "", "item": [ { "id": "21f21dc9-0071-46c0-b7d8-7498fc2fba6f", "name": "Consultar uso del API", "request": { "name": "Consultar uso del API", "description": { "content": "Devuelve el consumo de documentos del mes actual, el límite de tu plan y el costo estimado.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a3f86d05-e0cd-43d1-8ee6-6d5f0484b9e6", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"currentMonth\": {},\n \"plan\": {},\n \"monthlyQuota\": {},\n \"monthlyUsed\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bebe2b6-08e9-45e7-8211-46c6cbe3cb7f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c88bdf4-bd9b-46c9-b52b-d4ce0c792ea8", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71aa7883-760d-41f8-9702-4cac423509a0", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f1438bb-c6c3-4d98-87f2-bdb60dd95757", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c97006-8bd3-4b7e-ba51-f6e517a9b4f5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "certificate", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "abce645f-f503-414f-9696-b2aedc0981d7", "name": "Estado del certificado digital", "request": { "name": "Estado del certificado digital", "description": { "content": "Indica si el certificado P12 configurado en tu cuenta está vigente, su fecha de vencimiento y el RUC del titular. Si no está vigente, los comprobantes no podrán firmarse.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fd02d342-e720-4a3e-9da3-62b11c8510ce", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"hasCertificate\": \"\",\n \"isExpired\": \"\",\n \"daysUntilExpiry\": {},\n \"ruc\": {},\n \"legalName\": {},\n \"issuedAt\": {},\n \"expiresAt\": {},\n \"issuer\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ad3c7f4-376a-4295-b70b-1f71f472d29b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad0b86f8-494b-426a-808c-d06987fe1f10", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f9da4ea-b0e9-4f1e-8e00-253ae5fce323", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb517bb1-9c91-44eb-8f23-173963d9a7fb", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dda587a-ca3e-4f98-8fca-8cb5010ff10b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "certificate", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Subir firma electrónica (P12)", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "Archivo P12 (.p12 o .pfx)" }, { "key": "password", "value": "", "type": "text", "description": "Contraseña del certificado P12" } ] }, "url": { "raw": "{{baseUrl}}/developer/certificate", "host": [ "{{baseUrl}}" ], "path": [ "developer", "certificate" ] }, "description": "Sube un certificado P12. Si el RUC del certificado no existe como contribuyente en tu cuenta y tu plan lo permite, el contribuyente se crea automáticamente y se vincula a tu API key." }, "response": [] } ] }, { "name": "customers", "description": "", "item": [ { "id": "b0ffb416-624f-4586-a81c-271ac89b01f4", "name": "Crear cliente", "request": { "name": "Crear cliente", "description": { "content": "Crea un nuevo cliente en tu directorio de contactos. Puedes usar RUC (13 dígitos), cédula (10 dígitos), pasaporte o consumidor final.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "746d4ef7-d792-4dcc-9a27-bf24ad7730ac", "name": "Resource created successfully", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"identificationType\": \"CEDULA\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"address\": {},\n \"phone\": {},\n \"additionalEmail\": {},\n \"deletedAt\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c01b56fc-e3b8-43bc-abc0-8bced8536664", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c9dcae6-67aa-4f58-991c-5ca85ac462c5", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6924d69-0d36-48e5-9dd5-2887cb04f458", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e764caa8-07bc-4dfd-9e9f-ae51d7594826", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c12d2e1d-62a7-4c69-b9ab-8e2b2856f5be", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9000a9e8-6dec-43a7-888b-22f67e3d4a9b", "name": "Listar clientes", "request": { "name": "Listar clientes", "description": { "content": "Lista todos tus clientes con paginación. Puedes buscar por nombre o número de identificación.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6d5fd747-f1d2-40ec-9d43-9137167be953", "name": "Paginated list response", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"address\": {},\n \"phone\": {},\n \"additionalEmail\": {},\n \"deletedAt\": {}\n },\n {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"identificationType\": \"CEDULA\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"address\": {},\n \"phone\": {},\n \"additionalEmail\": {},\n \"deletedAt\": {}\n }\n ],\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\",\n \"pagination\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d626c61-7d01-43d0-8bf7-ed0be86dd2dd", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c868853-50e7-4257-8282-e6eb2c4376b5", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8be6e4d1-e21f-426b-a935-a8be6ac90611", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c08b3785-086e-4601-8823-fcae0158df11", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e380092-4b80-459c-aaeb-e5ef511d71c9", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, identification, or email", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by identification type (This can only be one of RUC,CEDULA,PASSPORT,FINAL_CONSUMER,EXTERIOR)", "type": "text/plain" }, "key": "identificationType", "value": "FINAL_CONSUMER" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "6ddd2d76-7efe-406b-95f3-fd98b5bf7e0f", "name": "Obtener cliente", "request": { "name": "Obtener cliente", "description": { "content": "Devuelve el detalle completo de un cliente específico por su ID.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f622571d-c38e-4346-8f2a-e5885c4bae2d", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"identificationType\": \"CEDULA\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"address\": {},\n \"phone\": {},\n \"additionalEmail\": {},\n \"deletedAt\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d68eb00e-27eb-4139-b812-f665e88c73d4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a21e5a8d-0bd2-49f8-a9b2-4ab5f3ee18d4", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb8970ba-9d94-44f6-a493-6ab91a61713e", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47fb9707-f43d-4859-a3f8-af49931f26d4", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "382e3d4b-f1ef-4d47-aef9-7520194d0eda", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a6cc1a6-aa17-4623-b0c8-cbd0e927ba6b", "name": "Actualizar cliente", "request": { "name": "Actualizar cliente", "description": { "content": "Actualiza uno o más campos de un cliente existente. Solo se actualizan los campos enviados en el body.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5df9a14c-8949-4c5e-a26e-0d4e9bcc35e7", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"identificationType\": \"CEDULA\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"address\": {},\n \"phone\": {},\n \"additionalEmail\": {},\n \"deletedAt\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f363ef9b-8a53-42e2-93b9-82a7462f5f5c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a40e8b47-3049-4bfe-bd9e-3ab2994e6f46", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "593ffcbe-e04a-4bf5-8914-5b3964ea7096", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbc69279-4a5c-4072-be88-a6c850adf50c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb90ab0c-9bd4-47ae-bdea-7c5f12d5608e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identificationType\": \"FINAL_CONSUMER\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"additionalEmail\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9e48e39-f157-4095-a328-00abb14d3435", "name": "Eliminar cliente", "request": { "name": "Eliminar cliente", "description": { "content": "Elimina un cliente del directorio. Esta acción no afecta los comprobantes ya emitidos a ese cliente.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "81661ad6-29f6-427a-9f1e-5adb61a3fe08", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"message\": \"\"\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79771d19-626b-4519-b4a9-3922298f3133", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2ddc0f-9e87-4b22-ab38-9448e533d879", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00b3b882-75ab-4ac5-8e00-012ae7cf2c73", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85843c32-f9b3-491b-83ab-94ffb4d6f5b9", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e286db-69fc-4684-a087-f0b0a87aefa8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del cliente", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "products", "description": "", "item": [ { "id": "b9effaca-7190-4a3e-81b7-af4cb30cb94a", "name": "Crear producto o servicio", "request": { "name": "Crear producto o servicio", "description": { "content": "Crea un nuevo producto o servicio en tu catálogo. Define el código, nombre, precio unitario y tipo de IVA aplicable.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "93b2cadd-5f07-4cc7-a96b-0fd7ab0df737", "name": "Resource created successfully", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"irbpnr\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"auxiliaryCode\": {},\n \"description\": {},\n \"iceCode\": {},\n \"iceRate\": {},\n \"unitOfMeasure\": {},\n \"deletedAt\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a919e798-c43c-4989-8582-c59c241a8b6c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2f07e89-4162-4e79-b1a2-fefc9010ca83", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb84c7e1-9c61-47c7-b608-71e5d7faf474", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f93c30a9-9dc4-48a0-a38a-8a45cc4d1986", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45ac89d0-4790-4200-b93b-64ce1dd3ff9a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"auxiliaryCode\": \"\",\n \"description\": \"\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a120df0e-3837-4758-a34d-4e044fd988e8", "name": "Listar productos", "request": { "name": "Listar productos", "description": { "content": "Lista todos tus productos y servicios con paginación. Puedes buscar por nombre o código.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c6e50ec2-80e4-4395-b74a-4f8a4ee401f3", "name": "Paginated list response", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"EXEMPT\",\n \"irbpnr\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"auxiliaryCode\": {},\n \"description\": {},\n \"iceCode\": {},\n \"iceRate\": {},\n \"unitOfMeasure\": {},\n \"deletedAt\": {}\n },\n {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_0\",\n \"irbpnr\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"auxiliaryCode\": {},\n \"description\": {},\n \"iceCode\": {},\n \"iceRate\": {},\n \"unitOfMeasure\": {},\n \"deletedAt\": {}\n }\n ],\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\",\n \"pagination\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c19e6b2-208f-4b9e-bd34-adc8c77de217", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bfc1927-0ff2-4af1-b728-fc44d45c8896", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15a14ee-d21a-4186-a3c1-19d7d8ae8189", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d2bd8fe-0ea0-422c-a6e7-b1030f81ef78", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c627213f-6dd5-4258-9211-bcdd4075893f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Search by name, code, or description", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (This can only be one of PRODUCT,SERVICE)", "type": "text/plain" }, "key": "type", "value": "PRODUCT" }, { "disabled": false, "description": { "content": "Filter by tax type (This can only be one of IVA_0,IVA_RATE,NOT_TAXABLE,EXEMPT)", "type": "text/plain" }, "key": "taxType", "value": "EXEMPT" }, { "disabled": false, "description": { "content": "Filter by active status", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "0f21e91e-6924-45d2-a1ce-c9b6f00c49fe", "name": "Obtener producto", "request": { "name": "Obtener producto", "description": { "content": "Devuelve el detalle completo de un producto o servicio específico por su ID.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "321d7029-434a-4b05-826f-a04d1c74e214", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"irbpnr\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"auxiliaryCode\": {},\n \"description\": {},\n \"iceCode\": {},\n \"iceRate\": {},\n \"unitOfMeasure\": {},\n \"deletedAt\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b0030b9-ceaa-4ae4-a7b6-22a77f847067", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2674ca7-d7a1-43f0-9e30-d01f24dc5dd8", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3fb45ca-876c-419c-b37e-7203d06b9556", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d32f03e1-4fd1-4b2f-8081-21e37de0368b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc66ab4-6357-4b3b-a17f-3772ca321320", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8044afbc-796d-499f-a765-82aa816a1b4a", "name": "Actualizar producto", "request": { "name": "Actualizar producto", "description": { "content": "Actualiza uno o más campos de un producto o servicio existente. Solo se actualizan los campos enviados en el body.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2306f267-84eb-4c54-8644-9aba71ee6210", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"taxpayerId\": \"\",\n \"code\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"irbpnr\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"auxiliaryCode\": {},\n \"description\": {},\n \"iceCode\": {},\n \"iceRate\": {},\n \"unitOfMeasure\": {},\n \"deletedAt\": {}\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a13695c7-2c8b-4c85-8a4e-f3577ff0d4a1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acc2d08b-9a02-4274-8a8e-5aa34e7b3230", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d514a48a-9297-47aa-b164-93de6861c97e", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8275d19e-af15-4d91-b12d-6e2c205f7636", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb8f0050-f1b7-45fa-bdc3-009bce2b92bc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"auxiliaryCode\": \"\",\n \"type\": \"PRODUCT\",\n \"name\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"taxType\": \"IVA_RATE\",\n \"iceCode\": \"\",\n \"iceRate\": \"\",\n \"irbpnr\": false,\n \"unitOfMeasure\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f6acb9c-62be-4b0c-8495-3f889497174e", "name": "Eliminar producto", "request": { "name": "Eliminar producto", "description": { "content": "Elimina un producto o servicio del catálogo. Esta acción no afecta los comprobantes ya emitidos con ese producto.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fb7f52d2-6902-4311-b0e9-43e70d23f3bf", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"message\": \"\"\n },\n \"meta\": {\n \"requestId\": \"\",\n \"timestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "116a2428-18a6-47bd-9a92-09278aa224b0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61b7abba-b581-4451-855d-700669aaaea8", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83e6a882-b211-4581-8415-40ee1dcf73f0", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7868d0c1-8992-4173-8166-a6fc737494b2", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2b0c3a7-aeff-4202-b8d5-c70d69011167", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "developer", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID del producto", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "credit-notes", "description": "Notas de crédito — emitir, consultar, descargar y anular", "item": [ { "id": "cn-001-emit", "name": "Emitir nota de crédito", "request": { "name": "Emitir nota de crédito", "description": { "content": "Emite una nota de crédito para una factura identificada por su clave de acceso de 49 dígitos. Si la factura no existe en el sistema se importa automáticamente desde el SRI (XML + PDF, sin correo).", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoiceAccessKey\": \"\",\n \"reason\": \"Error en datos del cliente\",\n \"items\": [\n {\n \"code\": \"SERV-001\",\n \"description\": \"Servicio de desarrollo web\",\n \"quantity\": 1,\n \"unitPrice\": 100.00,\n \"taxType\": \"IVA_RATE\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "cn-001b-list", "name": "Listar notas de crédito", "request": { "name": "Listar notas de crédito", "description": { "content": "Lista las notas de crédito emitidas con paginación. Filtra por RUC del cliente, estado y rango de fechas.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ruc", "value": "", "description": "Filtrar por RUC o cédula del cliente", "disabled": true }, { "key": "status", "value": "", "description": "Estado: DRAFT | PENDING | PROCESSING | AUTHORIZED | REJECTED | VOIDED", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Fecha de inicio ISO 8601 (ej. 2025-01-01)", "disabled": true }, { "key": "dateTo", "value": "", "description": "Fecha de fin ISO 8601 (ej. 2025-12-31)", "disabled": true }, { "key": "page", "value": "1", "description": "Página (por defecto: 1)", "disabled": true }, { "key": "limit", "value": "20", "description": "Resultados por página (por defecto: 20, máximo: 100)", "disabled": true } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "cn-002-get", "name": "Obtener nota de crédito", "request": { "name": "Obtener nota de crédito", "description": { "content": "Devuelve el detalle completo de una nota de crédito por su ID.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de crédito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "cn-003-status", "name": "Estado de la nota de crédito", "request": { "name": "Estado de la nota de crédito", "description": { "content": "Devuelve el estado de procesamiento: PROCESSING, AUTHORIZED, COMPLETED, ERROR o REJECTED.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de crédito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "cn-004-xml", "name": "Descargar XML de nota de crédito", "request": { "name": "Descargar XML de nota de crédito", "description": { "content": "Devuelve una URL pre-firmada del XML autorizado (expira en 5 minutos).", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de crédito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "cn-005-pdf", "name": "Descargar PDF de nota de crédito", "request": { "name": "Descargar PDF de nota de crédito", "description": { "content": "Devuelve una URL pre-firmada del PDF RIDE (expira en 5 minutos).", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de crédito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "cn-006-void", "name": "Anular nota de crédito", "request": { "name": "Anular nota de crédito", "description": { "content": "Anula la nota de crédito a nivel del sistema. El estado cambia a ANULADO. La anulación ante el SRI es responsabilidad del desarrollador.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de crédito" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Error en datos del cliente\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "nc-007-sequential", "name": "Actualizar secuencial de notas de crédito", "request": { "name": "Actualizar secuencial de notas de crédito", "description": { "content": "Establece el próximo número secuencial para notas de crédito en el punto de emisión indicado. El nuevo valor entra en efecto en el siguiente comprobante emitido.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "credit-notes", "sequential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"branchCode\": \"001\",\n \"emissionCode\": \"001\",\n \"creditNoteSequential\": 100\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] } ] }, { "name": "debit-notes", "description": "Notas de débito — emitir, consultar, descargar y anular", "item": [ { "id": "dn-001-emit", "name": "Emitir nota de débito", "request": { "name": "Emitir nota de débito", "description": { "content": "Emite una nota de débito a partir de una factura ya autorizada, identificada por su clave de acceso de 49 dígitos. Si la factura no existe en el sistema debe estar previamente importada.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "debit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoiceAccessKey\": \"\",\n \"reasons\": [\n {\n \"description\": \"Ajuste de precio\",\n \"amount\": 10.00,\n \"taxType\": \"IVA\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "dn-001b-list", "name": "Listar notas de débito", "request": { "name": "Listar notas de débito", "description": { "content": "Lista las notas de débito emitidas con paginación. Filtra por RUC del cliente, estado y rango de fechas.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "debit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ruc", "value": "", "description": "Filtrar por RUC o cédula del cliente", "disabled": true }, { "key": "status", "value": "", "description": "Estado: DRAFT | PENDING | PROCESSING | AUTHORIZED | REJECTED | VOIDED", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Fecha de inicio ISO 8601 (ej. 2025-01-01)", "disabled": true }, { "key": "dateTo", "value": "", "description": "Fecha de fin ISO 8601 (ej. 2025-12-31)", "disabled": true }, { "key": "page", "value": "1", "description": "Página (por defecto: 1)", "disabled": true }, { "key": "limit", "value": "20", "description": "Resultados por página (por defecto: 20, máximo: 100)", "disabled": true } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "dn-002-get", "name": "Obtener nota de débito", "request": { "name": "Obtener nota de débito", "description": { "content": "Devuelve el detalle completo de una nota de débito por su ID.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de débito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "dn-003-status", "name": "Estado de la nota de débito", "request": { "name": "Estado de la nota de débito", "description": { "content": "Devuelve el estado de procesamiento: PROCESSING, AUTHORIZED, COMPLETED, ERROR o REJECTED.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de débito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "dn-004-xml", "name": "Descargar XML de nota de débito", "request": { "name": "Descargar XML de nota de débito", "description": { "content": "Devuelve una URL pre-firmada del XML autorizado (expira en 5 minutos).", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de débito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "dn-005-pdf", "name": "Descargar PDF de nota de débito", "request": { "name": "Descargar PDF de nota de débito", "description": { "content": "Devuelve una URL pre-firmada del PDF RIDE (expira en 5 minutos).", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de débito" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "dn-006-void", "name": "Anular nota de débito", "request": { "name": "Anular nota de débito", "description": { "content": "Anula la nota de débito a nivel del sistema. El estado cambia a ANULADO. La anulación ante el SRI es responsabilidad del desarrollador.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la nota de débito" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Emitida por error\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "nd-007-sequential", "name": "Actualizar secuencial de notas de débito", "request": { "name": "Actualizar secuencial de notas de débito", "description": { "content": "Establece el próximo número secuencial para notas de débito en el punto de emisión indicado. El nuevo valor entra en efecto en el siguiente comprobante emitido.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "debit-notes", "sequential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"branchCode\": \"001\",\n \"emissionCode\": \"001\",\n \"debitNoteSequential\": 100\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] } ] }, { "name": "withholdings", "description": "Retenciones — emitir, consultar, descargar y anular", "item": [ { "id": "wh-001-emit", "name": "Emitir retención", "request": { "name": "Emitir retención", "description": { "content": "Emite un comprobante de retención vinculado a una factura ya autorizada, identificada por su clave de acceso de 49 dígitos.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "withholdings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoiceAccessKey\": \"\",\n \"taxes\": [\n {\n \"taxType\": \"RENTA\",\n \"taxRateCode\": \"303\",\n \"taxRate\": 10,\n \"taxBase\": 1000.00\n },\n {\n \"taxType\": \"IVA\",\n \"taxRateCode\": \"725\",\n \"taxRate\": 30,\n \"taxBase\": 150.00\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "wh-001b-list", "name": "Listar retenciones", "request": { "name": "Listar retenciones", "description": { "content": "Lista las retenciones emitidas con paginación. Filtra por RUC del cliente, estado y rango de fechas.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "withholdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ruc", "value": "", "description": "RUC o cédula del proveedor", "disabled": true }, { "key": "status", "value": "AUTHORIZED", "description": "DRAFT | PENDING | PROCESSING | AUTHORIZED | REJECTED | VOIDED", "disabled": true }, { "key": "dateFrom", "value": "2026-01-01", "description": "Fecha inicio ISO 8601", "disabled": true }, { "key": "dateTo", "value": "2026-12-31", "description": "Fecha fin ISO 8601", "disabled": true }, { "key": "page", "value": "1", "disabled": true }, { "key": "limit", "value": "20", "disabled": true } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "wh-002-get", "name": "Obtener retención", "request": { "name": "Obtener retención", "description": { "content": "Obtiene el detalle completo de una retención por su ID.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la retención" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "wh-003-status", "name": "Estado de la retención", "request": { "name": "Estado de la retención", "description": { "content": "Consulta el estado de procesamiento de una retención. Útil para hacer polling hasta que el estado sea AUTHORIZED o REJECTED.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la retención" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "wh-004-xml", "name": "Descargar XML de retención", "request": { "name": "Descargar XML de retención", "description": { "content": "Devuelve una URL pre-firmada de S3 (expira en 5 min) para descargar el XML autorizado.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la retención" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "wh-005-pdf", "name": "Descargar PDF de retención", "request": { "name": "Descargar PDF de retención", "description": { "content": "Devuelve una URL pre-firmada de S3 (expira en 5 min) para descargar el RIDE en PDF.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la retención" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "wh-006-void", "name": "Anular retención", "request": { "name": "Anular retención", "description": { "content": "Anula la retención a nivel del sistema. El estado cambia a ANULADO. La anulación ante el SRI es responsabilidad del desarrollador.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la retención" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Emitida por error\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] } ] }, { "name": "waybills", "description": "Guías de remisión — emitir, consultar, descargar y anular", "item": [ { "id": "gr-001-emit", "name": "Emitir guía de remisión", "request": { "name": "Emitir guía de remisión", "description": { "content": "Emite una guía de remisión electrónica. El sistema genera el XML, lo firma con tu certificado P12 y lo autoriza ante el SRI de forma asíncrona.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "waybills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emissionPointId\": \"\",\n \"customer\": {\n \"identificationType\": \"RUC\",\n \"identification\": \"\",\n \"legalName\": \"\",\n \"email\": \"\"\n },\n \"transporterRuc\": \"\",\n \"transporterName\": \"\",\n \"vehiclePlate\": \"ABC-1234\",\n \"departureAddress\": \"\",\n \"transportStartDate\": \"2026-06-10\",\n \"transportEndDate\": \"2026-06-11\",\n \"items\": [\n {\n \"code\": \"PROD-001\",\n \"description\": \"Descripción de la mercadería\",\n \"quantity\": 10\n }\n ],\n \"destinations\": [\n {\n \"receiverIdentification\": \"\",\n \"receiverName\": \"\",\n \"address\": \"\",\n \"transferReason\": \"Venta de mercadería\",\n \"codDocSustento\": \"01\",\n \"numDocSustento\": \"001-001-000000001\"\n }\n ],\n \"additionalInfo\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "gr-001b-list", "name": "Listar guías de remisión", "request": { "name": "Listar guías de remisión", "description": { "content": "Lista las guías de remisión emitidas con paginación. Filtra por estado, búsqueda general y rango de fechas.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "waybills" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "AUTHORIZED", "description": "PROCESSING | AUTHORIZED | REJECTED | VOIDED | ERROR", "disabled": true }, { "key": "search", "value": "", "description": "Búsqueda general (secuencial, clave de acceso, destinatario)", "disabled": true }, { "key": "dateFrom", "value": "2026-01-01", "description": "Fecha inicio ISO 8601", "disabled": true }, { "key": "dateTo", "value": "2026-12-31", "description": "Fecha fin ISO 8601", "disabled": true }, { "key": "page", "value": "1", "disabled": true }, { "key": "limit", "value": "20", "disabled": true } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "gr-002-get", "name": "Obtener guía de remisión", "request": { "name": "Obtener guía de remisión", "description": { "content": "Obtiene el detalle completo de una guía de remisión por su ID.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la guía de remisión" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "gr-003-status", "name": "Estado de la guía de remisión", "request": { "name": "Estado de la guía de remisión", "description": { "content": "Consulta el estado de procesamiento de una guía de remisión. Útil para hacer polling hasta que el estado sea AUTHORIZED o REJECTED.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la guía de remisión" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "gr-004-xml", "name": "Descargar XML de guía de remisión", "request": { "name": "Descargar XML de guía de remisión", "description": { "content": "Devuelve una URL pre-firmada de S3 (expira en 5 min) para descargar el XML autorizado.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la guía de remisión" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "gr-005-pdf", "name": "Descargar PDF de guía de remisión", "request": { "name": "Descargar PDF de guía de remisión", "description": { "content": "Devuelve una URL pre-firmada de S3 (expira en 5 min) para descargar el PDF (RIDE).", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la guía de remisión" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] }, { "id": "gr-006-void", "name": "Anular guía de remisión", "request": { "name": "Anular guía de remisión", "description": { "content": "Marca la guía como VOIDED en Factuplan. La anulación ante el SRI es responsabilidad del emisor.", "type": "text/plain" }, "url": { "path": [ "v1", "developer", "receipts", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "ID de la guía de remisión" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-taxpayer-ruc", "value": "{{taxpayerRuc}}" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Emitida por error\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [] } ] } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "/" }, { "key": "taxpayerRuc", "value": "0950194407001", "type": "string" } ], "info": { "_postman_id": "2de5c2ea-1fa3-4299-974a-383b40a5bb1a", "name": "Factuplan API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Electronic Billing API for Ecuador (SRI)", "type": "text/plain" } } }