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:


Cabeçalho (Header)
CampoTipoExemploDescrição
instanciastring1Identificador da instância
fgTpNotastringCana de Muda MensalTipo da nota fiscal
noNfinteger1Número da NF
cdSerieNfstring1Série da NF
cdUnidIndinteger1Unidade industrial
cdTpPropinteger2Tipo de propriedade
cdUpnivel1string10005BCódigo da UPNIVEL 1 (Ex. Fazenda)
deUpNivel1stringSÃO PEDRODescrição da UPNIVEL 1 (Ex. Fazenda)
deNatOperstringNOTA CANA MUDANatureza da operação
cdFiscOpinteger1101Código fiscal operação
cdFornecinteger28785Código do fornecedor
deFornecstringTOTVS SANome do fornecedor
cdSafrainteger2016Safra associada
amFornecstring(date-time)2016-04-01T00:00:00Mês/Ano referência fornecedor
acPesointeger156136Peso acumulado
vlTotNfnumber10079.55Valor total da NF
dtEmisNfstring(date-time)2016-04-30T00:00:00Data emissão NF
acTxContribnumber231.83Taxa contribuição acumulada
vlLiqNfnumber9847.72Valor líquido NF
cdTpCalcstring/nullnullTipo de cálculo
fgComplPrecostring/nullnullFlag complemento preço
deObsstring/nullnullObservação
deFiscOpstring/nullnullDescrição operação fiscal
cdClassFiscstring/nullnullClassificação fiscal
fgSubstituicaostring/nullnullFlag Substituição tributária
vlCredIcmsfnumber/nullnullCrédito ICMS
fgAcertoAnualstring/nullnullFlag acerto anual
fgManAutostringMFlag manual/automático
fgCprstring/nullnullFlag CPR
fgIndividualstring/nullnullFlag individual
noContrCanainteger1262Contrato de cana
cdEmpresastring1Código empresa
instContrstring1Instância contrato
cdMunicstring/nullnullMunicípio
noNfComplinteger/nullnullNF complementar
cdSerieNfComplstring/nullnullSérie NF complementar
noNfErpComplstring/nullnullNF ERP complementar
Detalhe ( Detail)
CampoTipoExemploDescrição
cdUnidIndinteger1Unidade industrial
vlTonCananumber57.38Valor por tonelada
ddFiminteger30Dia fim do período
vlFatorKnumber/nullnullFator K
noNfinteger1Número NF
vlTotalServnumber/nullnullValor total serviço
vlRefnumber/nullnullValor referência
qCanaEntinteger5073060Quantidade cana entregue
vlTotalnumber291092.18Valor total
cdSerieNfstring1Série NF
vlAcertoAtrnumber/nullnullValor acerto ATR
vlAcAtrRecebnumber/nullnullValor ATR recebido
instanciastring1Instância
vlKgAtrnumber/nullnullValor ATR/kg
cdTpCalcstring/nullnullTipo cálculo
dataInicialinteger1Data inicial
pcPgVlTonnumber/nullnullPercentual pagamento tonelada
vlBonusTonnumber/nullnullValor bônus tonelada
Histórico de Taxas
CampoTipoExemploDescrição
dtIniPerstring(date-time)2016-04-01T00:00:00Data início período
cdGrpTxContrinteger1Grupo taxa contribuição
instanciastring1Instância
cdUnidIndinteger1Unidade industrial
dtFimPerstring(date-time)2016-04-30T00:00:00Data fim período
vlTxContribnumber6112.94Valor taxa contribuição
cdTxContrinteger1Código taxa contribuição



Método GET:

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

{
   "hasNext":true,
   "items":[
      {
         "instancia":"1",
         "cdTpNota":"A",
         "deTpNota":"Desconhecido",
         "noNf":1,
         "cdSerieNf":"1",
         "cdUnidInd":1,
         "cdTpProp":2,
         "deNatOper":"Nota Amortização Man",
         "cdFiscOp":1101,
         "cdSafra":2016,
         "amFornec":"2016-04-01T00:00:00",
         "acPeso":5073060,
         "vlTotNf":291092.18,
         "dtEmisNf":"2016-04-30T00:00:00",
         "acTxContrib":6695.12,
         "vlLiqNf":284397.06,
         "cdTpCalc":null,
         "fgComplPreco":null,
         "deObs":null,
         "deFiscOp":null,
         "cdClassFisc":null,
         "dfSubstituicao":null,
         "vlCredIcmsf":null,
         "fgAcertoAnual":null,
         "fgManAuto":"M",
         "dfCpr":null,
         "fgIndividual":null,
         "noContrCana":1852,
         "cdEmpresa":"1",
         "instContr":"1",
         "cdMunic":null,
         "noNfCompl":null,
         "cdSerieNfCompl":null,
         "noNfErpCompl":null,
         "infoUpnivel1":[
            {
               "cdUpnivel1":"10950A",
               "deUpnivel1":"SANTA CARLOTA",
               "cdFornec":944,
               "fgTpPess":"J",
               "cdIntErp":"1_1051_1"
            }
         ],
         "infoFornecs":[
            {
               "cdFornec":944,
               "deFornec":"ESP.SYLVIO DE SAMPAIO M. JUNIOR E OUTRO",
               "fgTpFornec":"2",
               "deTpFornec":"FORNECEDOR",
               "fgTpPess":"F",
               "cdIntErp":"944"
            }
         ],
         "detalheNfDeOut":[
            {
               "cdUnidInd":1,
               "vlTonCana":57.38,
               "ddFim":30,
               "vlFatorK":null,
               "noNf":1,
               "vlTotalServ":null,
               "vlRef":null,
               "qCanaEnt":5073060,
               "vlTotal":291092.18,
               "cdSerieNf":"1",
               "vlAcertoAtr":null,
               "vlAcAtrReceb":null,
               "instancia":"1",
               "detalheshistTxOut":[
                  {
                     "dtIniPer":"2016-04-01T00:00:00",
                     "cdGrpTxContr":1,
                     "instancia":"1",
                     "cdUnidInd":1,
                     "dtFimPer":"2016-04-30T00:00:00",
                     "vlTxContrib":6112.94,
                     "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":"2016-04-01T00:00:00",
                     "cdGrpTxContr":1,
                     "instancia":"1",
                     "cdUnidInd":1,
                     "dtFimPer":"2016-04-30T00:00:00",
                     "vlTxContrib":582.18,
                     "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.