Árvore de páginas

Objetivo

Endpoint para inclusão de relacionamento de CFOP por tributação em um CGO específico

Chamada

POST [URLAPI]/TributacaoAPI/api/v1/CFOP/cgo

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)

codGeralOperCódigo geral operaçãointeger

obrigatório

valor mínimo 1 e valor máximo 999999

nroTributacaoNúmero da tributaçãointeger

obrigatório

valor mínimo 1 e valor máximo 99999

indContribICMSIndicador de contribuição ICMSnumber(1)

obrigatório

S - Sim

N- Não

cfopEstadoCFOP estadointeger

opcional

valor mínimo 1 e valor máximo 9999

cfopForaEstadoCFOP fora estadointeger

opcional

valor mínimo 1 e valor máximo 9999

cfopExternoCFOP externointeger

opcional

valor mínimo 1 e valor máximo 9999

{
  "codGeralOper": 999999,
  "nroTributacao": 99999,
  "indContribICMS": "s",
  "cfopEstado": 9999,
  "cfopForaEstado": 9999,
  "cfopExterno": 9999
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "codGeralOper": 0,
  "nroTributacao": 0,
  "indContribICMS": "string",
  "cfopEstado": 0,
  "cfopForaEstado": 0,
  "cfopExterno": 0
}

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
    }
  ]
}
  • Sem rótulos