Páginas filhas
  • API Notas Fiscais de Cana Muda

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • Modelo de integração padronizado para orquestrar consultas e bloqueios.

  • Novo cadastro de status vinculado a um parâmetro de configuração da API que controla o comportamento dentro do TOTVS Agro Bioenergia.

  • Bloqueio de reversões já integradas em sistemas de origem do Bioenergia, preservando a integridade do processo.

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
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

...