Empresarial Empresarial Entrar
Empresarial

Biblioteca de integracao

Como usar a API

Esta pagina apresenta os endpoints publicados para integracoes externas no dominio zucattiborges.empresarial.inf.br. A URL base deste ambiente e https://zucattiborges.empresarial.inf.br/api.

Base URL

https://zucattiborges.empresarial.inf.br/api

Use esta base para as chamadas da integracao.

Autenticacao

Bearer token

Envie o token de API do usuario no header Authorization.

Fluxo recomendado

  1. 1. Gere um token de API para o usuario autorizado.
  2. 2. Configure a integracao para usar a Base URL deste dominio.
  3. 3. Envie Accept: application/json em todas as requisicoes.
  4. 4. Use filtros e paginacao para manter respostas objetivas.
  5. 5. Revogue e gere um novo token em caso de suspeita de exposicao.

Autenticacao

O token deve ser enviado como Bearer token.

Authorization: Bearer SEU_TOKEN_DE_API
Accept: application/json
Content-Type: application/json

Endpoints publicados

Pessoas

Cadastro de pessoas disponivel para a integracao autenticada.

  • GET /V1/tenant/pessoa: Listar pessoas com paginacao e filtros opcionais.
  • POST /V1/tenant/pessoa: Criar uma pessoa.
  • GET /V1/tenant/pessoa/{codigo}: Consultar uma pessoa pelo codigo.
  • PUT/PATCH /V1/tenant/pessoa/{codigo}: Atualizar uma pessoa pelo codigo.
  • DELETE /V1/tenant/pessoa/{codigo}: Excluir uma pessoa pelo codigo.

Documentos de Movimento

Operacoes sobre documentos de movimento disponiveis para a integracao autenticada.

  • GET /V1/tenant/docmov: Listar documentos com paginacao e filtros opcionais.
  • POST /V1/tenant/docmov: Criar um documento de movimento.
  • GET /V1/tenant/docmov/{codigo}: Consultar um documento pelo codigo.
  • PUT/PATCH /V1/tenant/docmov/{codigo}: Atualizar um documento pelo codigo.
  • DELETE /V1/tenant/docmov/{codigo}: Excluir um documento pelo codigo.
  • POST /V1/tenant/docmov/{codigo}/concluir: Concluir um documento.
  • POST /V1/tenant/docmov/{codigo}/cancelar: Cancelar um documento.

Exemplo: listar pessoas

GET https://zucattiborges.empresarial.inf.br/api/V1/tenant/pessoa?search=exemplo&per_page=50
Authorization: Bearer SEU_TOKEN_DE_API
Accept: application/json

Exemplo: criar pessoa

POST https://zucattiborges.empresarial.inf.br/api/V1/tenant/pessoa
Authorization: Bearer SEU_TOKEN_DE_API
Content-Type: application/json

{
  "nomefantasia": "Cliente Exemplo",
  "razaosocial": "Cliente Exemplo LTDA",
  "inscrfederal": "00000000000000",
  "cliente": 1
}

Exemplo: listar documentos

GET https://zucattiborges.empresarial.inf.br/api/V1/tenant/docmov?empresa=1&estab=1&dataemissao_ini=2026-01-01&dataemissao_fim=2026-01-31&per_page=50
Authorization: Bearer SEU_TOKEN_DE_API
Accept: application/json

Respostas esperadas

  • 200: consulta executada.
  • 201: registro criado.
  • 401: autenticacao ausente ou invalida.
  • 404: recurso nao encontrado.
  • 422: payload ou parametros invalidos.
  • 429: limite de requisicoes excedido.

Filtros de documentos

A listagem de documentos aceita filtros por identificadores, situacao, periodo de emissao, texto de busca e paginacao.

Filtros diretos

  • empresa: codigo da empresa.
  • estab: codigo do estabelecimento.
  • situacao: situacao do documento.
  • pessoa: codigo da pessoa vinculada.
  • tipomov: codigo do tipo de movimento.
  • docserie: codigo da serie do documento.

Busca e periodo

  • search: busca por codigo, numero do documento ou nome da pessoa.
  • dataemissao_ini: data inicial de emissao no formato YYYY-MM-DD.
  • dataemissao_fim: data final de emissao no formato YYYY-MM-DD.
  • per_page: quantidade de registros por pagina.
  • page: pagina desejada na consulta paginada.
GET https://zucattiborges.empresarial.inf.br/api/V1/tenant/docmov?empresa=1&estab=1&situacao=1&search=12345&page=1&per_page=50
Authorization: Bearer SEU_TOKEN_DE_API
Accept: application/json

Formato de resposta

{
  "sucesso": true,
  "mensagem": "obtidos com sucesso",
  "data": [],
  "meta": {
    "pagina_atual": 1,
    "ultima_pagina": 1,
    "por_pagina": 50,
    "total": 0
  }
}

Resumo OpenAPI

Referencia compacta para IAs e integradores

openapi: 3.0.3
servers:
  - url: https://zucattiborges.empresarial.inf.br/api
security:
  - bearerAuth: []
paths:
  /V1/tenant/pessoa:
    get:
      summary: Lista pessoas
    post:
      summary: Cria pessoa
  /V1/tenant/pessoa/{codigo}:
    get:
      summary: Consulta pessoa
    patch:
      summary: Atualiza pessoa
    delete:
      summary: Exclui pessoa
  /V1/tenant/docmov:
    get:
      summary: Lista documentos
    post:
      summary: Cria documento
  /V1/tenant/docmov/{codigo}:
    get:
      summary: Consulta documento
    patch:
      summary: Atualiza documento
    delete:
      summary: Exclui documento
  /V1/tenant/docmov/{codigo}/concluir:
    post:
      summary: Conclui documento
  /V1/tenant/docmov/{codigo}/cancelar:
    post:
      summary: Cancela documento
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
Voltar ao inicio