← InícioFleetPay / API

Importar serviços e documentos em lote

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/servicos/import
importarServicosEmLoteBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Recebe lote JSON de serviços/documentos para processamento assíncrono no trilho operacional da company autenticada.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Repasses e Comprovantes
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

Lista de itens de serviço para criação em lote.

application/json

shipper_cnpjstring | nullOpcional

CNPJ do embarcador quando aplicável.

itemsarrayObrigatório

Itens de serviço do lote.

Respostas

202 Resposta HTTP

Lote recebido para processamento assíncrono.

application/json

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

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

422 Resposta HTTP

Falha de validação estrutural do lote.

Definição Completa da Operação
{
  "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": []
}