Crear Formas de Pago

Descripción

Permite crear una o múltiples formas de pago en el sistema mediante una única petición. Este endpoint está diseñado para operaciones en lote (batch), permitiendo insertar hasta 10,000 registros por petición.

Las formas de pago definen los métodos mediante los cuales los clientes pueden realizar pagos (efectivo, transferencia, crédito, etc.).

El sistema utiliza una operación MERGE que solo inserta formas de pago nuevas. Si una forma de pago con el mismo code ya existe, será ignorada (no se actualizará).

---

Endpoint

POST /api/payment-methods/batch-create

---

Headers

Header	Valor	Descripción
Content-Type	application/json	Especifica que el contenido es JSON

---

Body (JSON)

El body debe ser un array de objetos, donde cada objeto representa una forma de pago a crear.

Límites

Parámetro	Valor	Descripción
Mínimo de items	1	El array no puede estar vacío
Máximo de items	10,000	Número máximo de formas de pago por petición

---

Campos Requeridos

Estos campos son obligatorios en cada objeto del array:

Campo	Tipo	Longitud	Descripción
code	String	Max 10	Código único de la forma de pago
description	String	Max 50	Descripción de la forma de pago

Formato de tipos de datos

• String: Cadena de texto. La longitud indica el máximo de caracteres permitidos.

---

Campos Opcionales

Estos campos pueden incluirse opcionalmente en cada objeto:

Campo	Tipo	Longitud	Descripción
type	String	Max 1	Tipo de forma de pago (ej: “E” = Efectivo, “C” = Crédito, etc)

---

Ejemplo de Petición

A continuación se muestra un ejemplo completo de creación de formas de pago:

curl -X POST "https://your-api-url/api/payment-methods/batch-create" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "code": "EFE",
      "description": "Efectivo",
      "type": "E"
    },
    {
      "code": "TRF",
      "description": "Transferencia Bancaria",
      "type": "T"
    },
    {
      "code": "CRE30",
      "description": "Crédito a 30 días",
      "type": "C"
    }
  ]'

Ejemplo mínimo (solo campos requeridos)

curl -X POST "https://your-api-url/api/payment-methods/batch-create" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "code": "CHQ",
      "description": "Cheque"
    },
    {
      "code": "TAR",
      "description": "Tarjeta de Crédito"
    }
  ]'

---

Respuesta Exitosa

Status Code: 201 Created

{
  "statusCode": 201,
  "message": "Payment methods created successfully"
}

Importante

Las formas de pago que ya existan en el sistema (mismo code) serán ignoradas sin generar error. Solo se insertarán las formas de pago nuevas.

---

Respuestas de Error

Error 400 - JSON Inválido

Se produce cuando el body de la petición no contiene un JSON válido.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "message": "Invalid JSON in request body"
    }
  ]
}

---

Error 400 - Body No Es Un Array

Se produce cuando el body no es un array de objetos.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": null,
      "field": null,
      "message": "Request body must be an array"
    }
  ]
}

---

Error 400 - Array Vacío

Se produce cuando el array no contiene ningún elemento.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": null,
      "field": null,
      "message": "Request body cannot be empty"
    }
  ]
}

---

Error 400 - Excede Límite de Batch

Se produce cuando el array contiene más de 10,000 elementos.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": null,
      "field": null,
      "message": "Array exceeds maximum limit of 10000 items"
    }
  ]
}

---

Error 400 - Errores de Validación por Item

Se produce cuando uno o más items del array tienen errores de validación. Cada error incluye el índice del item en el array.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": 0,
      "errors": [
        {
          "field": "code",
          "message": "Field is required"
        },
        {
          "field": "description",
          "message": "Field is required"
        }
      ]
    },
    {
      "index": 2,
      "errors": [
        {
          "field": "code",
          "message": "Field exceeds maximum length of 10 characters"
        }
      ]
    }
  ]
}

Tipos de errores de validación por campo

Error	Descripción
Field is required	El campo obligatorio no fue enviado o está vacío
Field must be a string	El valor no es una cadena de texto
Field exceeds maximum length of X characters	La cadena excede la longitud máxima permitida
Unknown field	Se envió un campo que no existe en la configuración
Item must be an object	Un elemento del array no es un objeto JSON

---

Error 500 - Error de Validación Inesperado

Se produce cuando ocurre un error inesperado durante el proceso de validación de datos.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Unexpected validation error: [descripción del error]"
    }
  ]
}

---

Error 500 - Error de Conexión a Base de Datos

Se produce cuando hay problemas de conexión con la base de datos.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Error connecting to database: [descripción del error]"
    }
  ]
}

---

Error 500 - Error de Operación en Base de Datos

Se produce cuando la operación en la base de datos falla durante la ejecución.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Database operation failed: [descripción del error]"
    }
  ]
}

---

Error 500 - Error Inesperado

Se produce ante cualquier error no controlado durante el procesamiento.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Unexpected error: [descripción del error]"
    }
  ]
}

---

Códigos de Estado HTTP

Código	Descripción
201	Formas de pago creadas exitosamente
400	Error en la estructura o validación de los datos
500	Error interno del servidor

Para más información sobre los códigos de estado, consulta la sección de Códigos de estado HTTP.

---

Notas Importantes

• El endpoint utiliza una operación MERGE que solo inserta registros nuevos.
• Las formas de pago existentes (mismo code) son ignoradas sin generar error.
• Todos los campos de texto son sensibles a mayúsculas/minúsculas.
• La fecha de creación (FECHA_CREA) se asigna automáticamente por el sistema.
• Los estados por defecto para facturas, cotizaciones y devoluciones se configuran automáticamente como “APROBADO”.
• Se recomienda enviar lotes de máximo 1,000 registros para un mejor rendimiento.
• El campo type puede usarse para clasificar las formas de pago según su naturaleza (efectivo, crédito, transferencia, etc.).