Skip to content

Guía de despacho opcional ​

POST /api/Invoice/add_list_dispatch_guide_optional

Emite guías de despacho en las que el chofer, el despachador y el vehículo son opcionales. Es la misma emisión que Guía de despacho (mismo cuerpo, mismas reglas, misma respuesta y mismos errores); úsala cuando esos datos aún no se conocen al emitir.

Autenticación: Authorization: Bearer <token> (cómo obtenerlo) · Content-Type: application/json

Diferencias con la guía de despacho ​

AspectoGuía de despachoGuía de despacho opcional
empleadosObligatorio, no vacío.Opcional. Puedes omitirlo o enviarlo vacío.
Chofer y despachadorSiempre se exige al menos un chofer y un despachador.Solo si envías empleados: en ese caso debe haber al menos un chofer y un despachador.
vehiculoObligatorio, con sus 4 datos.Opcional. Si lo envías (y no está vacío), sus 4 datos son obligatorios.
Guía sin empleados ni vehículoNo permitida.Se guarda con chofer, despachador y vehículo en blanco.

Todo lo demás (cliente, productos, numeroSerie, cantidadGDP, numeración, respuesta) es idéntico; consulta los detalles en Guía de despacho.

Cuerpo de la solicitud ​

CampoTipoObligatorioDescripción y reglas
numeroSeriestringSíCódigo de la serie de numeración del negocio (por ejemplo "A").
cantidadGDPintegerSíCantidad de guías enviadas; entero e igual al número de elementos de guiasDeDespacho.
guiasDeDespachoarraySíGuías a emitir. Al menos una.
guiasDeDespacho[].numeroDeGuiaDeDespachostringSíNúmero de la guía. Solo dígitos, máximo 19 caracteres. Único en el envío y en el negocio.
guiasDeDespacho[].documentoIdentidadClientestringSíLetra V, E, P, J, G o C seguida de 8 a 10 dígitos. Ejemplo: J123456789.
guiasDeDespacho[].nombreRazonSocialClientestringSíNombre o razón social del cliente.
guiasDeDespacho[].correoClientestringSíCorreo del cliente (se normaliza y debe quedar válido).
guiasDeDespacho[].direccionClientestringSíDirección fiscal del cliente.
guiasDeDespacho[].telefonoClientestringSíTeléfono del cliente, por ejemplo "04141234567".
guiasDeDespacho[].origenstringRecomendadoOrigen del traslado. No se valida; se imprime en la guía.
guiasDeDespacho[].destinostringRecomendadoDestino del traslado. No se valida; se imprime en la guía.
guiasDeDespacho[].productosarraySíAl menos un producto.
productos[].codigoProductostringSíMáximo 13 caracteres, sin espacios, sin repetirse en la guía. Si no existe, se crea.
productos[].nombreProductostringSíMáximo 400 caracteres.
productos[].descripcionProductostringSíMáximo 400 caracteres.
productos[].tipoImpuestostringSíE, R, G, A o P.
productos[].cantidadAdquiridanumber o stringSíMayor que 0, con punto decimal.
productos[].precioProductostringSíMayor que 0, hasta 2 decimales, separador . o ,.
guiasDeDespacho[].empleadosarrayNoSi se envía y no está vacío: cada empleado con nombre, apellido, DocumentoIdentidad (letra + exactamente 8 dígitos), cargo (chofer o despachador, sin distinguir mayúsculas) y correo válido; y debe haber al menos un chofer y un despachador.
guiasDeDespacho[].vehiculoobjectNoSi se envía y no está vacío: placaVehiculo, tipoVehiculo, colorVehiculo y codigoVehiculo, todos obligatorios.

Ejemplo de solicitud ​

Guía sin empleados ni vehículo:

json
{
  "numeroSerie": "A",
  "cantidadGDP": 1,
  "guiasDeDespacho": [
    {
      "numeroDeGuiaDeDespacho": "123456",
      "documentoIdentidadCliente": "V12345678",
      "nombreRazonSocialCliente": "Cliente Ejemplo C.A.",
      "correoCliente": "cliente@example.com",
      "direccionCliente": "Av. Principal, Caracas",
      "telefonoCliente": "04141234567",
      "origen": "Almacén central",
      "destino": "Oficina del cliente",
      "productos": [
        {
          "codigoProducto": "PROD-01",
          "nombreProducto": "PRODUCTO DE PRUEBA",
          "descripcionProducto": "PRODUCTO DE PRUEBA 1 UNIDAD",
          "tipoImpuesto": "G",
          "cantidadAdquirida": "2",
          "precioProducto": "150.50"
        }
      ]
    }
  ]
}

Respuesta exitosa ​

HTTP 200

json
{
  "success": true,
  "message": "Guías de despacho guardadas satisfactoriamente",
  "dispatch_guide_errors": [],
  "dispatch_guide_success": [
    {
      "dispatch_guide_number": "123456",
      "control_number": "00-00000131",
      "dispatch_guide_pdf": "https://api.example.com/readonly/export_pdf/7b1e4d0a-9c6f-42d3-a8e5-b2c7f0d93e15"
    }
  ]
}

Las claves son las mismas que en Guía de despacho.

Errores ​

Son los mismos que en Guía de despacho, con estas diferencias:

HTTPMensaje (ejemplo)Causa
400Si se envían empleados, la guía de despacho 123456 necesita un Chofer y un Despachador.Se enviaron empleados pero falta un chofer o un despachador.
400El campo Placa del Vehículo en la guía 123456 es obligatorio.Se envió vehiculo pero le falta un dato (análogos para Tipo, Color y Código del Vehículo).
400El campo Nombre del Trabajador en la guía 123456 es obligatorio.Se envió un empleado incompleto (análogos para los demás datos del empleado).

En esta variante no se producen los errores El campo Trabajador en la guía ... es obligatorio y no debe estar vacío. ni El campo Vehículo en la guía ... es obligatorio y no debe estar vacío.

Notas ​

  • Sin empleados, la guía se guarda sin chofer ni despachador asociados; sin vehiculo, los datos del vehículo quedan en blanco.
  • Las demás notas de Guía de despacho aplican igual; en particular, si varias guías del mismo envío tienen traslados distintos, envíalas en solicitudes separadas.

API de Facturación · CG Imprenta Digital