Consulta de CFOP

Regras de negócio

CFOP é a abreviação de (Código Fiscal de Operações e Prestações) .É estabelecido pela Receita Federal e é utilizado desta forma no ERP. Para realizar as consultas referente aos CFOP, os mesmos devem estar cadastrados corretamente no ERP.
OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044600714-CFOP

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a ClassificacaoFiscalOperacao que por sua vez instancia a tabela TGFCFO mapeando os campos principais.
Para realizarmos a busca através do Json, utilizamos o serviço "CRUDServiceProvider.loadRecords".

O serviço CRUDServiceProvider.loadRecords é o serviço para ser utilizado para consulta de dados através do JSON.

No exemplo abaixo foi utilizado como filtro o campo CODCFO para buscar os códigos fiscais de operação.
• CODCFO – Código Fiscal do tipo de operação;

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
      "criteria":{
         "expression": {
            "$": "CODCFO = ?"
         },
         "parameter":[
            {
               "type":"I",
               "value":3205
            }
         ]
      }

Para melhor performance sempre utilize nas suas consultas apenas os campos necessários, para evitar tráfego de dados que não serão utilizados.

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TGFCFO

Exemplo de uso:


URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json

Corpo de requisição
{
  "serviceName":"CRUDServiceProvider.loadRecords",
  "requestBody":{
    "dataSet":{
      "rootEntity": "ClassificacaoFiscalOperacao",
      "includePresentationFields": "N",
      "tryJoinedFields":"true",
      "offsetPage": "0",
      "criteria":{
        "expression": {
          "$": "this.CODCFO = ?"
        },
        "parameter": [
          {
            "$": "3205",
            "type": "I"
          }
        ]
      },
      "entity": [
        {
          "path":"",
          "fieldset": {
            "list": "CODCFO, DESCRCFO, TRIBUTADASCIAP, TIPICMS, CODCTACTB, GRUPOCFO, TIPO, CONVPRODUZ, CALCDIFICMS, RECBRUTAEFDBLOCOP, TIPOPERPRODEP"
          }
        },
        {
          "path":"PlanoConta",
          "fieldset":{
            "list":"DESCRCTA"
          }
        }
      ]
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "AD7534B3BF89E1994F4C90C939AA2650",
    "responseBody": {
        "total": "1",
        "askRowsLimit": "0",
        "result": [
            [
                "3205",
                "ANUL VAL REL PREST SERV COMUN",
                "C",
                "1",
                "",
                "",
                "300",
                "",
                "N",
                "N",
                "N",
                ""
            ]
        ]
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!