Árvore de páginas

Objetivo

Método para realizar o agendamento para atualização dos dados fiscais da família na divisão.

Chamada

POST [URLAPI]/TributacaoAPI/api/v1/Agendamento/atualiza/dados-fiscais-familia-divisao

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Tributação > API Tributação


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

descricaoDescrição do lote de alteraçõesvarchar2(35)obrigatório
dtainivigenciaData de início de vigência dos dados informadosdateobrigatório.
seqfamiliaCódigo da família a ser alteradainteger($int64)obrigatório
nroDivisaoNúmero da divisão a ser alteradainteger($int64)obrigatório
nroTributacaoNúmero da tributação a ser alteradainteger($int32)opcional
seqPautaCódigo da pauta imposto a ser alteradainteger($int32)opcional

seqPautaICMS

Código da pauta imposto ICMS a ser alteradainteger($int64)opcional

seqPautaICMSAntec

Código da pauta imposto ICMS antecipada a ser alteradainteger($int32)opcional


OBS.: Para a inclusão é necessário informar pelo menos um dos campos opcionais (nroTributacao, seqPauta, seqPautaICMS, seqPautaICMSAntec).


{
  "descricao": "string",
  "dtaIniVigencia": "2025-08-28T14:31:06.391Z",
  "dadosFiscaisFamiliaDivsao": [
    {
      "seqFamilia": 0,
      "nroDivisao": 0,
      "nroTributacao": 0,
      "seqPauta": 0,
      "seqPautaICMS": 0,
      "seqPautaICMSAntec": 0
    }
  ]
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - CREATED

{
  "seqAlteracaoTrib": 0,
  "descricao": "string",
  "dtaIniVigencia": "2025-08-28T14:31:06.392Z",
  "status": "string",
  "usuInclusao": "string",
  "dtaInclusao": "2025-08-28T14:31:06.392Z"
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}