← InicioFleetPay / API

Importar servicios y documentos en lote

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/servicos/import
importarServicosEmLoteBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Recibe un lote JSON de servicios/documentos para procesamiento asíncrono en el flujo operativo de la company autenticada.

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Transferencias y Comprobantes
Perfiles Aplicables
Gestor de Transporte · Agregado Empresarial · Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

Lista de elementos de servicio para creación en lote.

application/json

shipper_cnpjstring | nullOpcional

CNPJ del embarcador cuando corresponda.

itemsarrayObligatorio

Elementos de servicio del lote.

Respuestas

202 Respuesta HTTP

Lote recibido para procesamiento asíncrono.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Respuesta HTTP

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

422 Respuesta HTTP

Falla de validación estructural del lote.

Definición Completa de la Operación
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "importarServicosEmLote",
  "summary": "Importar serviços e documentos em lote",
  "description": "Recebe lote JSON de serviços/documentos para processamento assíncrono no trilho operacional da company autenticada.",
  "requestBody": {
    "required": true,
    "description": "Lista de itens de serviço para criação em lote.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "items"
          ],
          "properties": {
            "shipper_cnpj": {
              "type": [
                "string",
                "null"
              ],
              "description": "CNPJ do embarcador quando aplicável."
            },
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true
              },
              "description": "Itens de serviço do lote."
            }
          }
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "Lote recebido para processamento assíncrono.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "422": {
      "description": "Falha de validação estrutural do lote."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/servicos/import",
  "parameters": []
}