Contexto Geral

A API tem objetivo de consultar às movimentações de NF de cana com parâmetros obrigatórios e opcionais para buscas mais assertivas, incorporando:

Estruturas:

AtributosDescriçãoTamanhoTipoObservação
instanciaIdentificador da instância do processo2NuméricoUsado como chave de controle interno
cdTpNotaCódigo do tipo de nota fiscal1Texto‘S’ indica nota de sobrepreço
deTpNotaDescrição do tipo de nota fiscal50TextoEx: “Nota Cana Sobrepreço”
noNfNúmero da nota fiscal10NuméricoIdentificação da NF
cdSerieNfSérie da nota fiscal5TextoSérie utilizada na emissão
cdUnidIndCódigo da unidade industrial5NuméricoRefere-se à usina ou filial
cdTpPropCódigo do tipo de propriedade2NuméricoRelacionado ao tipo de fornecedor (ex: próprio, parceria)
deNatOperDescrição da natureza da operação50TextoEx: “COMPRA”
cdFiscOpCódigo fiscal da operação10NuméricoCódigo CFOP ou equivalente
cdSafraCódigo do ano-safra4NuméricoEx: 2018
amFornecMês e ano de fornecimento10DataData base da operação
acPesoPeso acumulado de cana entregue15NuméricoEm quilos
vlTotNfValor total da nota fiscal15NuméricoValor bruto total
dtEmisNfData de emissão da NF10DataData em que a NF foi emitida
acTxContribTotal de contribuições acumuladas15NuméricoSoma das taxas aplicadas
vlLiqNfValor líquido da nota fiscal15NuméricoValor final após descontos
cdTpCalcCódigo do tipo de cálculo2NuméricoPode ser nulo
fgComplPrecoIndicador de complemento de preço1Texto‘N’ = não é complemento
deObsObservação da nota255TextoEx: “Nota Fiscal de Sobrepreço.”
deFiscOpDescrição fiscal da operação100TextoPode ser nulo
cdClassFiscCódigo de classificação fiscal10NuméricoPode ser nulo
dfSubstituicaoIndicador de substituição fiscal1TextoPode ser nulo
vlCredIcmsfValor de crédito de ICMS15NuméricoPode ser nulo
fgAcertoAnualIndicador de acerto anual1Texto‘N’ = não houve acerto anual
fgManAutoIndicador de manutenção automática1Texto‘A’ = automática
dfCprIndicador de CPR1TextoPode ser nulo
fgIndividualIndicador de operação individual1TextoPode ser nulo
noContrCanaNúmero do contrato de cana10NuméricoIdentifica o contrato associado
cdEmpresaCódigo da empresa5TextoEx: “1”
instContrInstância do contrato2TextoIdentifica a origem da NF
cdMunicCódigo do município10NuméricoPode ser nulo
noNfComplNúmero da NF complementar10NuméricoPode ser nulo
cdSerieNfComplSérie da NF complementar5TextoPode ser nulo
noNfErpComplNúmero ERP da NF complementar10TextoPode ser nulo





infoUpnivel1.cdUpnivel1Código da unidade superior10TextoEx: “20003”
infoUpnivel1.deUpnivel1Descrição da unidade superior50TextoEx: “TOTVS”
infoUpnivel1.cdFornecCódigo do fornecedor10NuméricoIdentificador ERP
infoUpnivel1.fgTpPessTipo de pessoa1Texto‘J’ = Jurídica
infoUpnivel1.cdIntErpCódigo integrado ERP20TextoIdentificação composta no ERP





infoFornecs.cdFornecCódigo do fornecedor10NuméricoIdentificação do fornecedor principal
infoFornecs.deFornecNome do fornecedor100TextoEx: “TOTVS FORN”
infoFornecs.fgTpFornecTipo de fornecedor2TextoEx: “2” = fornecedor
infoFornecs.deTpFornecDescrição do tipo de fornecedor50TextoEx: “FORNECEDOR”
infoFornecs.fgTpPessTipo de pessoa1Texto‘F’ = Física
infoFornecs.cdIntErpCódigo integrado ERP20TextoCódigo único no ERP





detalheNfDeOut.cdUnidIndCódigo da unidade industrial (detalhe)5NuméricoRelaciona-se à usina
detalheNfDeOut.vlTonCanaValor por tonelada de cana15NuméricoValor unitário
detalheNfDeOut.ddFimDia final do período2NuméricoEx: 31
detalheNfDeOut.vlFatorKFator K10NuméricoPode ser nulo
detalheNfDeOut.qCanaEntQuantidade de cana entregue15NuméricoEm quilos
detalheNfDeOut.vlTotalValor total15NuméricoSoma geral do período
detalheNfDeOut.cdSerieNfSérie da nota (detalhe)5TextoEx: “5”
detalheNfDeOut.vlKgAtrValor do ATR (kg)15NuméricoPode ser nulo
detalheNfDeOut.cdTpCalcCódigo do tipo de cálculo2NuméricoPode ser nulo
detalheNfDeOut.dataInicialDia inicial do período2NuméricoEx: 1





detalheshistTxOut.dtIniPerData inicial do período da taxa10DataEx: “2018-05-01”
detalheshistTxOut.dtFimPerData final do período da taxa10DataEx: “2018-05-31”
detalheshistTxOut.vlTxContribValor da contribuição15NuméricoEx: 449.73
detalheshistTxOut.cdTxContrCódigo da taxa de contrato5NuméricoIdentificador da taxa





txContrib.deTxcontrDescrição da taxa50TextoEx: “INSS” ou “SENAR”
txContrib.pcTxcontrPercentual da taxa6NuméricoEx: 1.3 ou 0.2
txContrib.cdIndBaseCódigo de índice base10NuméricoEx: 950
txContrib.fgAcertoAnoIndicador de acerto anual da taxa1Texto‘S’ = Sim
txContrib.codigoClassificacaoCódigo da classificação20TextoEx: “CLAS 1”
txContrib.codigoEspecieCódigo da espécie20TextoEx: “ESPECIE 1”


Método GET:

http:127.0.0.1:8080/api/query/v1/canaMuda

{
   "hasNext":true,
   "items":[
      {
         "instancia":"1",
         "cdTpNota":"S",
         "deTpNota":"Nota Cana Sobrepreço",
         "noNf":1,
         "cdSerieNf":"5",
         "cdUnidInd":1,
         "cdTpProp":5,
         "deNatOper":"COMPRA",
         "cdFiscOp":1101,
         "cdSafra":2018,
         "amFornec":"2018-05-01T00:00:00",
         "acPeso":4867980,
         "vlTotNf":34594.79,
         "dtEmisNf":"2018-05-22T00:00:00",
         "acTxContrib":518.92,
         "vlLiqNf":34075.87,
         "cdTpCalc":null,
         "fgComplPreco":"N",
         "deObs":"Nota Fiscal de Sobrepreço.",
         "deFiscOp":null,
         "cdClassFisc":null,
         "dfSubstituicao":null,
         "vlCredIcmsf":null,
         "fgAcertoAnual":"N",
         "fgManAuto":"A",
         "dfCpr":null,
         "fgIndividual":null,
         "noContrCana":2277,
         "cdEmpresa":"1",
         "instContr":"1",
         "cdMunic":null,
         "noNfCompl":null,
         "cdSerieNfCompl":null,
         "noNfErpCompl":null,
         "infoUpnivel1":[
            {
               "cdUpnivel1":" 20003",
               "deUpnivel1":"TOTVS",
               "cdFornec":7052,
               "fgTpPess":"J",
               "cdIntErp":"1_19_1"
            }
         ],
         "infoFornecs":[
            {
               "cdFornec":7052,
               "deFornec":"TOTVS FORN",
               "fgTpFornec":"2",
               "deTpFornec":"FORNECEDOR",
               "fgTpPess":"F",
               "cdIntErp":"7052"
            }
         ],
         "detalheNfDeOut":[
            {
               "cdUnidInd":1,
               "vlTonCana":7.1066,
               "ddFim":31,
               "vlFatorK":null,
               "noNf":1,
               "vlTotalServ":null,
               "vlRef":null,
               "qCanaEnt":4867980,
               "vlTotal":34594.79,
               "cdSerieNf":"5",
               "vlAcertoAtr":null,
               "vlAcAtrReceb":null,
               "instancia":"1",
               "detalheshistTxOut":[
                  {
                     "dtIniPer":"2018-05-01T00:00:00",
                     "cdGrpTxContr":1,
                     "instancia":"1",
                     "cdUnidInd":1,
                     "dtFimPer":"2018-05-31T00:00:00",
                     "vlTxContrib":449.73,
                     "cdTxContr":1,
                     "txContrib":[
                        {
                           "cdTxcontr":1,
                           "dtValIni":"2015-10-01T03:00:00.000+00:00",
                           "deTxcontr":"INSS",
                           "pcTxcontr":1.3,
                           "cdIndBase":950,
                           "pcRedBase":null,
                           "fgAcertoAno":"S",
                           "cdTxErp":null,
                           "codigoClassificacao":"CLAS 1",
                           "codigoEspecie":"ESPECIE 1"
                        }
                     ]
                  },
                  {
                     "dtIniPer":"2018-05-01T00:00:00",
                     "cdGrpTxContr":1,
                     "instancia":"1",
                     "cdUnidInd":1,
                     "dtFimPer":"2018-05-31T00:00:00",
                     "vlTxContrib":69.19,
                     "cdTxContr":2,
                     "txContrib":[
                        {
                           "cdTxcontr":2,
                           "dtValIni":"2015-10-01T03:00:00.000+00:00",
                           "deTxcontr":"SENAR",
                           "pcTxcontr":0.2,
                           "cdIndBase":950,
                           "pcRedBase":null,
                           "fgAcertoAno":"S",
                           "cdTxErp":null,
                           "codigoClassificacao":"CLAS 2",
                           "codigoEspecie":"ESPECIE 2"
                        }
                     ]
                  }
               ],
               "vlKgAtr":null,
               "cdTpCalc":null,
               "dataInicial":1,
               "pcPgVlTon":null,
               "vlBonusTon":null
            }
         ]
      }
   ]
}

Parâmetros Obrigatórios

Parâmetros Opcionais

Atualizar status de integração - Notas Fiscais de Cana Muda

Disponibilizado endpoint para atualização do status de integração dos registros de Notas Fiscais de Cana Muda, considerando o retorno do processamento de integração e as regras de bloqueio de reversões definidas no módulo Bioenergia.

Método PUT:

http:127.0.0.1:8080/api/query/v1/canaMuda



Body da Requisição - Notas Fiscais de Cana Muda


{ "fgStatusIntegracao": "1",
  "instancia": "1",
  "fgTpNota": "1",
  "noNf": 1,
  "cdSerieNf": "1",
  "cdUnidInd": 1,
  "cdUpnivel1": "",
  "deFornec": ""
}

Com o objetivo de assegurar a consistência das informações integradas com outros sistemas, foi desenvolvido uma nova funcionalidade dentro da aplicação Configuração Central (CFGCEN/ TOTVS Agro Bioenergia), onde será possível realizar o cadastro de rotinas executadas pelo TOTVS Agro Bioenergia e indicar os possíveis "status de integração" vindos de sistemas externos (que estejam integrados ao TOTVS Agro Bioenergia).

Para cada status indicado, será possível apontar se será permitido ou não a reversão do processo em questão.

Visando possibilitar a indicação de diferentes cadastros para diferentes processamentos disponíveis em nosso sistema, foram criados parâmetros específicos para cada rotina, 
onde o usuário deverá determinar qual cadastro deverá ser consultado no momento de realizar a reversão do processamento.

Importante frisar que, caso um ou mais registros apresentem um status onde esteja apontado o impedimento para reversão, o processamento será interrompido, impedindo a execução da reversão para todos os registros envolvidos.

Parâmetro "Código do cadastro de controle de status para NF de muda de cana":

  • Seção: RCMP_PGTCP;
  • Entrada:  CD_CAD_STATUS_INT_NFM;

Para mais detalhes sobre a funcionalidade citada acima, acesse a página Cadastro de Bloqueio de Movimentações via API.