01. DADOS GERAIS
Produto: | TOTVS Backoffice |
---|---|
Linha de Produto: | Linha Datasul |
Segmento: | Backoffice |
Módulo: | TOTVS Backoffice (Linha Datasul) - Faturamento (MFT) |
Função: | ImportInvoicePublic - API pública de Importação de Notas Fiscais |
País: | Brasil |
Requisito/Story/Issue: | DMANFATINOV-1493 |
02. SITUAÇÃO/REQUISITO
Disponibilizar nova API que possibilite a importação de notas fiscais no Datasul, como alternativa ao programa FT2015 - Importação de Notas Fiscais.
03. SOLUÇÃO
Foi criada a API ImportInvoicePublic, que possibilita importar informações de notas fiscais de saída geradas em outros sistemas, através de requisição HTTP, com dados no formato JSON.
Apenas devem ser ser importadas notas fiscais de modelo eletrônico, já integradas ao Fisco e impressas antes de serem integradas ao Datasul. Na importação, os documentos assumem a situação de Impressos e na execução da API são geradas as mesmas informações ao importar pelo programa FT2015.
A importação de uma nota fiscal utilizando a nova API segue a estrutura de campos especificados no Swagger, disponível no arquivo EMS2/ftp/api/v1/importInvoicePublic.json (pode ser visualizado através do Swagger Editor > File > Import File). Nesta Collection Postman contém uma requisição de exemplo de utilização da API.
A importação de notas fiscais via API pública contêm as mesmas validações e regras existentes no programa FT2015 - Importação de Notas Fiscais. Caso não ocorram erros durante a execução da API, a nota é gravada na base de dados do Datasul. Caso ocorram erros, os mesmos serão retornados via Response da requisição.
A API de Importação de Notas Fiscais lê as informações no Body da requisição no formato JSON, seguindo o layout especificado no arquivo Swagger mencionado anteriormente, com os campos também sendo detalhados abaixo:
Layout da Requisição (/dts/datasulrest/resources/prg/ftp/v1/importInvoicePublic)
importInvoice (nota-fiscal) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-docto.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-docto.serie | Série | |
invoiceNumber | Character | Sim | tt-docto.nr-nota | Número da Nota Fiscal | |
goodsTarget | Integer | Sim | tt-docto.cod-des-merc | Destino da Mercadoria | |
futureDeliveryPrintDate | Date | Não | tt-docto.dt-nf-ent-fut | Data Emissão Nota Fiscal de Entrega Futura | |
state | Character | Sim | tt-docto.estado | Estado | |
transactionTypeID | Character | Sim | tt-docto.nat-operacao | Natureza de Operação | |
customerID | Integer | Sim | tt-docto.cod-emitente | Código do Emitente | |
country | Character | Sim | tt-docto.pais | País | |
packingPercentage | Decimal | 2 | Não | tt-docto.perc-embalagem | Percentual Embalagem |
freightPercentage | Decimal | 2 | Não | tt-docto.perc-frete | Percentual Frete |
discountPercentage1 | Decimal | 3 | Não | tt-docto.perc-desco1 | Desconto-1 |
discountPercentage2 | Decimal | 3 | Não | tt-docto.perc-desco2 | Desconto-2 |
insurancePercentage | Decimal | 2 | Não | tt-docto.perc-seguro | Percentual de Seguro |
totalGrossWeight | Decimal | 3 | Sim | tt-docto.peso-bru-tot | Peso Bruto |
totalNetWeight | Decimal | 3 | Sim | tt-docto.peso-liq-tot | Peso Líquido |
packingValue | Decimal | 2 | Sim | tt-docto.vl-embalagem | Valor da Embalagem |
freightValue | Decimal | 2 | Não | tt-docto.vl-frete | Valor do Frete |
totalGoodsValue | Decimal | 2 | Sim | tt-docto.vl-mercad | Valor da Mercadoria |
insuranceValue | Decimal | 2 | Não | tt-docto.vl-seguro | Valor do Seguro |
distributionChannelID | Integer | Não | tt-docto.cod-canal-venda | Código Canal de Venda | |
district | Character | Sim | tt-docto.bairro | Bairro | |
zip | Character | Sim | tt-docto.cep | CEP | |
personalId | Character | Não | tt-docto.cgc | CNPJ/CPF | |
city | Character | Não | tt-docto.cidade | Cidade | |
cifCity | Character | Não | tt-docto.cidade-cif | Cidade CIF | |
deliveryID | Character | Não | tt-docto.cod-entrega | Código do Endereço de Entrega | |
tradeBillRefDate | Date | Não | tt-docto.dt-base-dup | Data Base Duplicata | |
printDate | Date | Sim | tt-docto.dt-emis-nota | Data de Emissão da Nota | |
address | Character | Não | tt-docto.endereco | Endereço | |
stateTaxID | Character | Sim | tt-docto.ins-estadual | Inscrição Estadual | |
markPackages | Character | Não | tt-docto.marca-volume | Marca Volumes | |
currency | Integer | Sim | tt-docto.mo-codigo | Moeda | |
mainRepresentativeName | Character | Sim | tt-docto.no-ab-reppri | Representante | |
reshipmentCarrierName | Character | Sim | tt-docto.nome-tr-red | Transportadora Redespacho | |
carrierName | Character | Sim | tt-docto.nome-transp | Transportador | |
icmsRestituitionLevelZF | Character | Não | tt-docto.nivel-rest | Nivel Restituição ICMS p/ Zona Franca | |
billNumber | Character | Sim | tt-docto.nr-fatura | Número da Fatura Obs.: Esse campo é de formato caracter porém deverão ser informados apenas números | |
priceTableID | Character | Sim | tt-docto.nr-tabpre | Número da Tabela de Preço | |
packageQuantity | Character | Não | tt-docto.nr-volumes | Número Volumes | |
restituitionPercentage | Decimal | 2 | Não | tt-docto.pc-rest | Percentual de Restituição |
vehicleLicensePlateID | Character | Não | tt-docto.placa | Placa | |
futureDeliverySeries | Character | Não | tt-docto.serie-ent-fut | Série Entrega Futura | |
futureDeliveryInvoiceNumber | Character | Não | tt-docto.nr-nota-ent-fut | Número da Nota Entrega Futura | |
siscomexNumber | Integer | Não | tt-docto.nr-siscomex | Número Siscomex | |
releaseInvoice | Logical | Sim | tt-docto.ind-lib-nota | Libera Nota Fiscal sem Saldo | |
routeID | Character | Não | tt-docto.cod-rota | Rota | |
messageCode | Integer | Não | tt-docto.cod-msg | Código da Mensagem | |
exportRate | Decimal | 8 | Não | tt-docto.vl-taxa-exp | Taxa Exportação |
exportProcessNumber | Character | Não | tt-docto.nr-proc-exp | Número Processo Exportação | |
financialTable | Integer | Não | tt-docto.nr-tab-finan | Tabela Financiamento | |
financialIndex | Integer | Não | tt-docto.nr-ind-finan | Índice Financiamento | |
collectorID | Integer | Não | tt-docto.cod-portador | Código Portador | |
collectingModality | Integer | Não | tt-docto.modalidade | Modalidade | |
baseInvoiceNumber | Character | Não | tt-docto.nr-nota-base | Número Nota Base | |
seriesBaseInvoiceNumber | Character | Não | tt-docto.serie-base | Série Base | |
vehicleLicensePlateState | Character | Não | tt-docto.uf-placa | UF Placa | |
shipmentDate | Date | Não | tt-docto.dt-embarque | Data de Saída da Mercadoria | |
seriesPriceDiffInvoiceNumber | Character | Não | tt-docto.serie-dif | Série Diferença de Preço | |
priceDiffInvoiceNumber | Character | Não | tt-docto.nr-nota-dif | Número Nota Diferença de Preço | |
increasePercentPriceDiff | Decimal | 2 | Não | tt-docto.perc-acres-dif | Percentual Acréscimo Diferença de Preço |
increaseValuePriceDiff | Decimal | 2 | Não | tt-docto.vl-acres-dif | Valor Acréscimo Diferença de Preço |
valueExportRatePriceDiff | Decimal | 8 | Não | tt-docto.vl-taxa-exp-dif | Valor Taxa Exportação Diferença de Preço |
redispatchTerms | Character | Não | tt-docto.cond-redespa | Condições Redespacho | |
comments | Character | Não | tt-docto.obs | Observação | |
cancellationDate | Date | Não | tt-docto.dt-cancela | Data de Cancelamento da Nota Fiscal | |
cancellationReason | Character | Não | tt-docto.motvo-cance | Descrição do Motivo do Cancelamento da Nota Fiscal | |
invoicingCurrency | Integer | Não | tt-docto.char-1,21,5 | Código da Moeda de Faturamento | |
priceTableDiscountPercentage | Decimal | 2 | Não | tt-docto-bn.val-pct-desconto-tab-preco | Valor Percentual Desconto Tabela Preço |
infDiscountPercent | Character | Não | tt-docto-bn.des-pct-desconto-inform | Percentuais Desconto Informados por Nota Fiscal | |
totalDiscountPercentage | Decimal | 4 | Não | tt-docto-bn.val-pct-desconto-total | Percentual Desconto Total Nota Fiscal |
totalDiscountAmount | Decimal | 2 | Não | tt-docto-bn.val-desconto-total | Valor Desconto Total |
discountPercentOrderAmount | Decimal | 4 | Não | tt-docto-bn.val-pct-desconto-valor | Percentual Desconto por Valor do Pedido |
fullAddress | Character | Não | tt-docto-bn.endereco_text | Endereço Completo | |
accessKeyNFe | Character | Não | tt-docto.char-1,112,60 | Código da Chave de Acesso NF-e | |
statusNFe | Integer | Não | tt-docto.char-1,172,2 | Situação da NF-e | |
issueTypeNFe | Integer | Não | tt-docto.char-1,174,1 | Tipo de Emissão NF-e | |
protocol | Character | Não | tt-docto.char-1,175,15 | Protocolo | |
freightModality | Character | Não | tt-docto.char-1,190,8 | Modalidade de Frete | |
typeCte | Integer | Não | tt-docto.char-1,198,2 | Tipo CT-e Onde: 01 = CT-e Normal | |
simpleNacIcmsRate | Decimal | 2 | Não | tt-docto.char-1,200,10 | Alíquota ICMS Simples Nacional |
paymentTerms | Integer | Sim | tt-docto.cod-cond-pag | Código Condição de Pagamento | |
userCancellation | Character | Não | tt-docto.char-2,3,12 | Usuário de Cancelamento da Nota Fiscal | |
additionalInformation | Character | Não | tt-docto.obs | Informações Adicionais de Interesse do Fisco | |
ibgeCodeSource | Integer | Não | tt-docto.char-1,241,10 | Código IBGE do Município de Origem | |
ibgeCodeTarget | Integer | Não | tt-docto.char-1,251,10 | Código IBGE do Município de Destino |
importInvoiceItems (it-nota-fisc) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-it-docto.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-it-docto.serie | Série | |
invoiceNumber | Character | Sim | tt-it-docto.nr-nota | Número da Nota Fiscal | |
itemSequenceInvoice | Integer | Sim | tt-it-docto.nr-sequencia | Sequência do item na nota fiscal | |
itemCode | Character | Sim | tt-it-docto.it-codigo | Item | |
reference | Character | Não | tt-it-docto.cod-refer | Referência | |
issueInventory | Logical | Sim | tt-it-docto.baixa-estoq | Baixa Estoque | |
fiscalClassification | Character | Sim | tt-it-docto.class-fiscal | Classificação Fiscal | |
supplemInvoiceDate | Date | Não | tt-it-docto.data-comp | Data Nota Complementar | |
supplemType | Character | Não | tt-it-docto.nat-comp | Natureza Complementar | |
transactionTypeID | Character | Sim | tt-it-docto.nat-operacao | Natureza de Operação | |
supplemInvoiceNumber | Character | Não | tt-it-docto.nro-comp | Número da Nota Complementar | |
discountPercent | Decimal | 5 | Não | tt-it-docto.per-des-item | Percentual de Desconto do Item |
enteredNetWeight | Decimal | 5 | Sim | tt-it-docto.peso-liq-it-inf | Peso Líquido |
packageWeight | Decimal | 5 | Não | tt-it-docto.peso-embal-it | Peso Embalagem |
internalQuantity | Decimal | 4 | Sim | tt-it-docto.quantidade[1] | Quantidade[1] |
invoiceQuantity | Decimal | 4 | Não | tt-it-docto.quantidade[2] | Quantidade[2] |
supplemSeq | Integer | Não | tt-it-docto.seq-comp | Sequência Complementar | |
supplemSeries | Character | Não | tt-it-docto.serie-comp | Série Complementar | |
internalUnitOfMeasure | Character | Sim | tt-it-docto.un[1] | Unidade Faturada[1] | |
invoiceUnitOfMeasure | Character | Não | tt-it-docto.un[2] | Unidade Faturada[2] | |
expenseValue | Decimal | 2 | Não | tt-it-docto.vl-despes-it | Valor Despesas |
packingValue | Decimal | 2 | Não | tt-it-docto.vl-embalagem | Valor Embalagem |
freightValue | Decimal | 2 | Não | tt-it-docto.vl-frete | Valor Frete |
goodsNetAmount | Decimal | 2 | Sim | tt-it-docto.vl-merc-liq | Valor Mercadoria Líquido |
goodsOriginalAmount | Decimal | 2 | Sim | tt-it-docto.vl-merc-ori | Valor Mercadoria Original |
tableGoodsValue | Decimal | 2 | Sim | tt-it-docto.vl-merc-tab | Valor Mercadoria Tabela |
originalPrice | Decimal | 5 | Sim | tt-it-docto.vl-preori | Preço Original |
priceTablePrice | Decimal | 5 | Sim | tt-it-docto.vl-pretab | Preço Tabela |
netPrice | Decimal | 5 | Sim | tt-it-docto.vl-preuni | Preço Líquido |
insuranceValue | Decimal | 2 | Não | tt-it-docto.vl-seguro | Valor Seguro |
itemTotalAmount | Decimal | 2 | Sim | tt-it-docto.vl-tot-item | Valor Total do Item |
wthhldIrrf | Logical | Não | tt-it-docto.ind-imprenda | Retém IRRF | |
strongCurrLiquidGoods | Decimal | 5 | Não | tt-it-docto.mercliq-moeda-forte | Valor Mercadoria Líquido Moeda Forte |
strongCurrOrigGoods | Decimal | 5 | Não | tt-it-docto.mercori-moeda-forte | Valor Mercadoria Original Moeda Forte |
strongCurrncyTabPrice | Decimal | 5 | Não | tt-it-docto.merctab-moeda-forte | Valor Mercadoria Tabela Moeda Forte |
restitutionLevel | Character | Não | tt-it-docto.nivel-rest | Nível Restituição | |
restitutionPercentage | Decimal | 2 | Não | tt-it-docto.pc-rest | Percentual de Restituição |
enteredGrossWeight | Decimal | 5 | Sim | tt-it-docto.peso-bru-it-inf | Peso Bruto |
exportRate | Decimal | 8 | Não | tt-it-docto.vl-taxa-exp | Taxa de Exportação |
discountAmount | Decimal | 2 | Não | tt-it-docto.vl-desconto | Valor do Desconto |
discountPercentage | Decimal | 5 | Não | tt-it-docto.vl-desconto-perc | Percentual de Desconto |
icmsTaxPercent | Decimal | 5 | Não | tt-it-imposto.aliquota-icm | Alíquota ICMS |
supplemIcmsTaxPercent | Decimal | 5 | Não | tt-it-imposto.aliq-icm-comp | Alíquota ICMS Complementar |
ipiTaxPercent | Decimal | 5 | Não | tt-it-imposto.aliquota-ipi | Alíquota IPI |
issTaxPercent | Decimal | 5 | Não | tt-it-imposto.aliquota-iss | Alíquota ISS |
icmsTaxationType | Integer | Sim | tt-it-imposto.cd-trib-icm | Código Tributação do ICMS | |
ipiTaxationType | Integer | Sim | tt-it-imposto.cd-trib-ipi | Código Tributação do IPI | |
issTaxationType | Integer | Sim | tt-it-imposto.cd-trib-iss | Código Tributação do ISS | |
serviceCode | Integer | Não | tt-it-imposto.cod-servico | Código do Serviço | |
wthhldSourceIcms | Logical | Sim | tt-it-imposto.ind-icm-ret | Retém ICMS na Fonte | |
icmsDiscountPercent | Decimal | 3 | Não | tt-it-imposto.per-des-icms | Percentual de Desconto de ICMS |
percRedIcm | Decimal | 4 | Não | tt-it-imposto.perc-red-icm | Percentual de Redução de ICMS |
percRedIpi | Decimal | 2 | Não | tt-it-imposto.perc-red-ipi | Percentual de Redução de IPI |
percRedIss | Decimal | 2 | Não | tt-it-imposto.perc-red-iss | Percentual de Redução de ISS |
vlBicmsEntFut | Decimal | 2 | Não | tt-it-imposto.vl-bicms-ent-fut | Base de Cálculo do ICMS de Entrega Futura |
vlBicmsIt | Decimal | 2 | Sim | tt-it-imposto.vl-bicms-it | Base de Cálculo do ICMS |
vlBipiEntFut | Decimal | 2 | Não | tt-it-imposto.vl-bipi-ent-fut | Base de Cálculo do IPI de Entrega Futura |
vlBipiIt | Decimal | 2 | Sim | tt-it-imposto.vl-bipi-it | Base de Cálculo do IPI |
vlBissIt | Decimal | 2 | Sim | tt-it-imposto.vl-biss-it | Base de Cálculo do ISS |
vlBsubsEntFut | Decimal | 2 | Não | tt-it-imposto.vl-bsubs-ent-fut | Base ICMS Subst. Tributária de Entrega Futura |
vlBsubsIt | Decimal | 2 | Não | tt-it-imposto.vl-bsubs-it | Base ICMS Subst. Tributária |
supplemIcms | Decimal | 2 | Não | tt-it-imposto.icm-complem | ICMS Complementar |
vlIcmsEntFut | Decimal | 2 | Não | tt-it-imposto.vl-icms-ent-fut | Valor ICMS de Entrega Futura |
vlIcmsIt | Decimal | 2 | Não | tt-it-imposto.vl-icms-it | Valor ICMS |
vlIcmsouIt | Decimal | 2 | Não | tt-it-imposto.vl-icms-outras e tt-it-imposto.vl-icmsou-it | Valor ICMS Outras |
vlIcmsntIt | Decimal | 2 | Não | tt-it-imposto.vl-icmsnt-it | Valor ICMS Não Tributado |
vlIcmsubEntFut | Decimal | 2 | Não | tt-it-imposto.vl-icmsub-ent-fut | Valor ICMS Subst. Tributária de Entrega Futura |
vlIcmsubIt | Decimal | 2 | Não | tt-it-imposto.vl-icmsub-it | Valor ICMS Subst. Tributária |
vlIpiEntFut | Decimal | 2 | Não | tt-it-imposto.vl-ipi-ent-fut | Valor IPI de Entrega Futura |
vlIpiIt | Decimal | 2 | Não | tt-it-imposto.vl-ipi-it | Valor IPI |
vlIpiouIt | Decimal | 2 | Não | tt-it-imposto.vl-ipi-outras e tt-it-imposto.vl-ipiou-it | Valor IPI Outras |
vlIpintIt | Decimal | 2 | Não | tt-it-imposto.vl-ipint-it | Valor IPI Não Tributado |
vlIrfIt | Decimal | 2 | Não | tt-it-imposto.vl-irf-it | Valor IRRF |
vlIssIt | Decimal | 2 | Não | tt-it-imposto.vl-iss-it | Valor ISS |
vlIssntIt | Decimal | 2 | Não | tt-it-imposto.vl-issnt-it | Valor ISS Não Tributado |
vlIssouIt | Decimal | 2 | Não | tt-it-imposto.vl-issou-it | Valor ISS Outras |
businessUnitID | Character | Não | tt-it-docto.char-2,172,03 | Código Unidade de Negócio | |
discountValueZF | Decimal | 2 | Não | tt-it-docto.desconto-zf | Valor do Desconto para Zona Franca |
itemNarrative | Character | Não | tt-it-docto.narrativa | Narrativa | |
priceTableDiscountPercentage | Decimal | 2 | Não | tt-it-docto-bn.val-pct-desconto-tab-preco | Valor Percentual Desconto Tabela Preço |
infDiscountPercent | Character | Não | tt-it-docto-bn.des-pct-desconto-inform | Percentuais Descontos Informados por Item da Nota | |
enteredDiscountAmount | Decimal | 2 | Não | tt-it-docto-bn.val-desconto-inform | Valor Desconto Informado |
totalDiscountPercentage | Decimal | 4 | Não | tt-it-docto-bn.val-pct-desconto-total | Percentual Desconto Total do Item da Nota |
totalDiscountAmount | Decimal | 2 | Não | tt-it-docto-bn.val-desconto-total | Valor Desconto Total |
periodDiscountPercent | Decimal | 3 | Não | tt-it-docto-bn.val-pct-desconto-periodo | Percentual Desconto referente ao Período controlado |
termDiscountPercent | Decimal | 3 | Não | tt-it-docto-bn.val-pct-desconto-prazo | Percentual Desconto referente ao Prazo de Pagamento |
discountValue1 | Decimal | 5 | Não | tt-it-docto-bn.val-desconto[1] | Descontos Parametrizados (1) Tabela Descontos |
discountValue2 | Decimal | 5 | Não | tt-it-docto-bn.val-desconto[2] | Descontos Parametrizados (2) Tabela Descontos |
discountValue3 | Decimal | 5 | Não | tt-it-docto-bn.val-desconto[3] | Descontos Parametrizados (3) Tabela Descontos |
discountValue4 | Decimal | 5 | Não | tt-it-docto-bn.val-desconto[4] | Descontos Parametrizados (4) Tabela Descontos |
discountValue5 | Decimal | 5 | Não | tt-it-docto-bn.val-desconto[5] | Descontos Parametrizados (5) Tabela Descontos |
discountValuePisZF | Decimal | 2 | Não | tt-it-docto.char-2,140,16 | Valor do Desconto PIS para Zona Franca |
discountValueCofinsZF | Decimal | 2 | Não | tt-it-docto.char-2,156,16 | Valor do Desconto COFINS para Zona Franca |
costAccount | Character | Não | tt-it-docto.ct-cuscon | Conta de Custo Contábil | |
costCenter | Character | Não | tt-it-docto.sc-cuscon | Centro de Custo | |
vlPisSt | Decimal | 2 | Não | tt-it-docto.char-2,175,14 | Valor PIS ST |
vlBpisSt | Decimal | 2 | Não | tt-it-docto.char-2,189,15 | Valor Base PIS ST |
pisStTaxPercent | Decimal | 4 | Não | tt-it-docto.char-2,204,06 | Alíquota PIS ST |
vlCofinsSt | Decimal | 2 | Não | tt-it-docto.char-2,210,14 | Valor COFINS ST |
vlBcofinsSt | Decimal | 2 | Não | tt-it-docto.char-2,224,15 | Valor Base COFINS ST |
cofinsStTaxPercent | Decimal | 4 | Não | tt-it-docto.char-2,239,06 | Alíquota COFINS ST |
csosnCode | Character | Não | tt-it-docto.char-2,245,10 | Código CSOSN Simples Nacional | |
simpleNacVlBicms | Decimal | 4 | Não | tt-it-docto.char-2,255,13 | Valor Base ICMS Simples Nacional |
simpleNacVlCredIcms | Decimal | 4 | Não | tt-it-docto.char-2,268,13 | Valor de Crédito Simples Nacional |
FciNumber | Character | Não | tt-it-docto.char-2,281,36 | Número FCI | |
inssServiceCode | Integer | Não | tt-it-docto.char-2,317,02 | Código de Serviço de INSS | |
vlBissRet | Decimal | 2 | Não | tt-it-imposto.char-1,65,14 | Base de Cálculo do ISS Retido |
issRetTaxPercent | Decimal | 2 | Não | tt-it-imposto.char-1,79,14 | Alíquota do ISS Retido |
vlIssRet | Decimal | 2 | Não | tt-it-imposto.char-1,93,14 | Valor do ISS Retido |
ipiTaxStatusCode | Character | Não | tt-it-docto.char-2,335,2 | Código Situação Tributária IPI | |
pisTaxStatusCode | Character | Não | tt-it-docto.char-2,337,2 | Código Situação Tributária PIS | |
cofinsTaxStatusCode | Character | Não | tt-it-docto.char-2,339,2 | Código Situação Tributária COFINS | |
vBCUFDest | Decimal | 2 | Não | tt-it-docto.char-2,341,15 | Valor da BC do ICMS na UF de destino (vBCUFDest) |
vBCFCPUFDest | Decimal | 2 | Não | tt-it-docto.char-2,471,15 | Valor da BC Fundo Combate Pobreza UF Dest (vBCFCPUFDest) |
pFCPUFDest | Decimal | 4 | Não | tt-it-docto.char-2,356,7 | Percent ICMS Fundo Combate Pobreza UF Dest (pFCPUFDest) |
pICMSUFDest | Decimal | 4 | Não | tt-it-docto.char-2,363,7 | Aliquota interna da UF de destino (pICMSUFDest) |
pICMSInter | Decimal | 4 | Não | tt-it-docto.char-2,370,7 | Aliquota interestadual das UF envolvidas (pICMSInter) |
pICMSInterPart | Decimal | 4 | Não | tt-it-docto.char-2,377,7 | Percent partilha do ICMS Interestadual (pICMSInterPart) |
vFCPUFDest | Decimal | 2 | Não | tt-it-docto.char-2,384,15 | Valor ICMS Fundo Combate Pobreza UF Dest (vFCPUFDest) |
vICMSUFDest | Decimal | 2 | Não | tt-it-docto.char-2,399,15 | Valor ICMS Interestadual para a UF Dest (vICMSUFDest) |
vICMSUFRemet | Decimal | 2 | Não | tt-it-docto.char-2,414,15 | Valor ICMS Interestadual para a UF Remet (vICMSUFRemet) |
TaxableUnitOfMeasure | Character | Não | tt-it-docto.char-2,429,2 | Unidade de Medida Tributável | |
TaxableQuantity | Decimal | 4 | Não | tt-it-docto.char-2,431,20 | Quantidade Unidade Tributável |
TaxableUnitValue | Decimal | 5 | Não | tt-it-docto.char-2,451,20 | Valor Unitário Unidade Tributável |
vlBfcp | Decimal | 2 | Não | tt-it-docto.char-2,486,15 | Valor BC FCP |
fcpPercent | Decimal | 4 | Não | tt-it-docto.char-2,501,7 | Percentual FCP |
vlFcp | Decimal | 2 | Não | tt-it-docto.char-2,508,15 | Valor FCP |
discountValueZFM | Decimal | 2 | Não | tt-it-docto.char-2,523,5 | Percentual de Desconto ZFM |
pisRedPercent | Decimal | 2 | Não | tt-it-docto.char-2,528,4 | Percentual de Redução PIS |
pisTaxCalcMethod | Integer | Não | tt-it-docto.char-2,532,1 | Forma de Cálculo PIS | |
pisTaxUnitValue | Decimal | 5 | Não | tt-it-docto.char-2,533,9 | Valor Unitário PIS |
vlPis | Decimal | 2 | Não | tt-it-docto.char-2,542,12 | Valor PIS |
vlBpis | Decimal | 2 | Não | tt-it-docto.char-2,554,12 | Valor Base PIS |
pisTaxPercent | Decimal | 4 | Não | tt-it-docto.char-2,566,7 | Aliquota PIS |
cofinsRedPercent | Decimal | 2 | Não | tt-it-docto.char-2,573,4 | Percentual de Redução COFINS |
cofinsTaxCalcMethod | Integer | Não | tt-it-docto.char-2,577,1 | Forma de Cálculo COFINS | |
cofinsTaxUnitValue | Decimal | 5 | Não | tt-it-docto.char-2,578,9 | Valor Unitário COFINS |
vlCofins | Decimal | 2 | Não | tt-it-docto.char-2,587,12 | Valor COFINS |
vlBcofins | Decimal | 2 | Não | tt-it-docto.char-2,599,12 | Valor Base COFINS |
cofinsTaxPercent | Decimal | 4 | Não | tt-it-docto.char-2,611,7 | Alíquota COFINS |
vlBfcpIcmsSt | Decimal | 2 | Não | tt-it-docto.char-2,618,15 | Valor BC FCP ICMS ST |
fcpIcmsStTaxPercent | Decimal | 4 | Não | tt-it-docto.char-2,633,7 | Percentual FCP ICMS ST |
vlFcpIcmsSt | Decimal | 2 | Não | tt-it-docto.char-2,640,15 | Valor FCP ICMS ST |
importInvoiceTransport (nota-trans) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-trans.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-nota-trans.serie | Série | |
invoiceNumber | Character | Sim | tt-nota-trans.nr-nota-fis | Número da Nota Fiscal | |
icmsTaxPercent | Decimal | 2 | Sim | tt-nota-trans.aliquota-icm | Alíquota ICMS |
vlBicms | Decimal | 2 | Sim | tt-nota-trans.vl-bicms | Base de Cálculo do ICMS |
insuranceValue | Decimal | 2 | Não | tt-nota-trans.vl-servico | Valor do Seguro |
percRedIcm | Decimal | 4 | Não | tt-nota-trans.perc-red-base | Percentual de Redução do ICMS |
vlIcms | Decimal | 2 | Sim | tt-nota-trans.vl-icms | Valor do ICMS |
messageCode | Integer | tt-nota-trans.cod-mensagem | Código da Mensagem | ||
responsibleFreight | Integer | Sim | tt-nota-trans.ind-cobranca | Responsável pelo Frete | |
wthhldSourceIcms | Logical | Não | tt-nota-trans.ind-icms-ret | Retém ICMS na Fonte | |
comments | Character | Não | tt-nota-trans.observacao | Observação |
importInvoiceBill (fat-duplic) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Sim | tt-docto.cod-estabel | Estabelecimento | ||
series | Character | Sim | tt-docto.serie | Série | |
invoiceNumber | Character | Sim | tt-docto.nr-nota | Número da Nota Fiscal | |
installmentNumber | Integer | Sim | tt-fat-duplic.parcela | Parcela | |
netValue | Decimal | 2 | Sim | tt-fat-duplic.vl-parcela | Valor da Parcela |
dueDateType | Integer | Sim | tt-fat-duplic.cod-vencto | Código do Vencimento | |
dueDate | Date | Sim | tt-fat-duplic.dt-venciment | Data de Vencimento | |
discountDate | Date | Não | tt-fat-duplic.dt-desconto | Data Desconto | |
discountValue | Decimal | 2 | Não | tt-fat-duplic.vl-desconto | Valor do Desconto |
comissionValue | Decimal | 2 | Não | tt-fat-duplic.vl-comis | Valor da Comissão |
accumAmtInvoices | Decimal | 2 | Sim | tt-fat-duplic.vl-acum-dup | Valor Acumulado Duplicatas |
docClassCode | Character | Sim | tt-fat-duplic.cod-esp | Espécie | |
paymentSlipNumber | Character | Não | tt-fat-duplic-boleto.nro-boleto | Número do Boleto |
importInvoiceRepresentative (fat-repre) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-trans.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-nota-trans.serie | Série | |
invoiceNumber | Character | Sim | tt-nota-trans.nr-nota-fis | Número da Nota Fiscal | |
representativeCode | Integer | Sim | tt-fat-repre.cod-rep | Código do Representante | |
representativeName | Character | Sim | tt-fat-repre.nome-ab-rep | Nome Abreviado do Representante | |
repCommissionPercentage | Decimal | 5 | Sim | tt-fat-repre.perc-comis | Percentual de Comissão do Representante |
issueCommission | Integer | Não | tt-fat-repre.comis-emis | Comissão de Emissão | |
comissionValue | Decimal | 2 | Não | tt-fat-repre.vl-comis | Valor da Comissão |
issueValue | Decimal | 2 | Não | tt-fat-repre.vl-emis | Valor da Emissão |
importInvoicePackage (nota-embal) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-embal.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-nota-embal.serie | Série | |
invoiceNumber | Character | Sim | tt-nota-embal.nr-nota-fis | Número da Nota Fiscal | |
packageShortName | Character | Sim | tt-nota-embal.sigla-emb | Sigla Embalagem | |
packageQuantity | Integer | Sim | tt-nota-embal.qt-volumes | Quantidade de Volumes | |
volumeDescription | Character | Não | tt-nota-embal.desc-vol | Descrição Volumes | |
packageNarrative | Character | Não | tt-nota-embal.narrativa | Narrativa |
importInvoiceItemPackage (item-embal) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-embal.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-nota-embal.serie | Série | |
invoiceNumber | Character | Sim | tt-nota-embal.nr-nota-fis | Número da Nota Fiscal | |
itemSequenceInvoice | Integer | Sim | tt-it-docto.nr-sequencia | Seqüência do item na nota fiscal | |
packageShortName | Character | Sim | tt-nota-embal.sigla-emb | Sigla Embalagem | |
packageQuantity | Integer | Sim | tt-item-embal.volume | Quantidade de Volumes | |
sequence | Integer | Sim | tt-item-embal.nr-sequencia | Sequência | |
itemCode | Character | Sim | tt-item-embal.it-codigo | Item | |
packedQuantity | Decimal | 4 | Sim | tt-item-embal.qt-embalada | Quantidade Embalada |
importInvoiceItemsbyLot (fat-ser-lote) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-embal.cod-estabel | Estabelecimento | |
series | Character | Sim | tt-nota-embal.serie | Série | |
invoiceNumber | Character | Sim | tt-nota-embal.nr-nota-fis | Número da Nota Fiscal | |
itemSequenceInvoice | Integer | Sim | tt-it-docto.nr-sequencia | Seqüência do item na nota fiscal | |
itemCode | Character | Sim | tt-saldo-estoq.it-codigo | Item | |
depositCode | Character | Sim | tt-saldo-estoq.cod-depos | Depósito | |
lotValidityDate | Date | Sim | tt-saldo-estoq.dt-vali-lote | Data de Validade do Lote | |
internalQuantity | Decimal | 4 | Sim | tt-saldo-estoq.quantidade | Quantidade Faturada |
lotCode | Character | Sim | tt-saldo-estoq.lote | Lote | |
reference | Character | Não | tt-saldo-estoq.cod-refer | Código de Referência do Item | |
locationCode | Character | Não | tt-saldo-estoq.cod-localiz | Localização |
importInvoiceDeliveryLocation (nota-fisc-adc) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-fisc-adc.cod-estab | Estabelecimento | |
series | Character | Sim | tt-nota-fisc-adc.cod-serie | Série | |
invoiceNumber | Character | Sim | tt-nota-fisc-adc.cod-nota-fisc | Número da Nota Fiscal | |
transportTypeIndicator | Integer | Sim | tt-nota-fisc-adc.idi-carga | Indicador do Tipo de Transporte da Carga Coletada Onde: 01 = Rodoviário | |
idCodeTaxpayerCollection | Character | Não | tt-nota-fisc-adc.cod-cnpj-contribt-coleta | C.N.P.J. Contribuinte Coleta | |
stateCodeTaxpayerCollection | Character | Não | tt-nota-fisc-adc.cod-inscr-estad-contribt-coleta | Inscrição Estadual Contribuinte Coleta | |
cpfTaxpayerCollection | Character | Não | tt-nota-fisc-adc.cod-cpf-contribt-coleta | C.P.F Contribuinte Coleta | |
ibgeCodeCollection | Integer | Não | tt-nota-fisc-adc.cod-munpio-coleta | Município Contribuinte Coleta (Código IBGE) | |
idCodeTaxpayerDelivery | Character | Não | tt-nota-fisc-adc.cod-cnpj-contribt-entreg | C.N.P.J. Contribuinte Entrega | |
stateCodeTaxpayerDelivery | Character | Não | tt-nota-fisc-adc.cod-inscr-estad-contribt-entreg | Inscrição Estadual Contribuinte Entrega | |
cpfTaxpayerDelivery | Character | Não | tt-nota-fisc-adc.cod-cpf-contribt-entreg | C.P.F Contribuinte Entrega | |
ibgeCodeDelivery | Integer | Não | tt-nota-fisc-adc.cod-munpio-entreg | Município Contribuinte Entrega (Código IBGE) |
importInvoiceReferenced (nota-fisc-adc) | |||||
Campo | Tipo | Dec. | Obrig. | Campo Temp-Table | Descrição |
siteID | Character | Sim | tt-nota-fisc-adc.cod-estab | Estabelecimento | |
series | Character | Sim | tt-nota-fisc-adc.cod-serie | Série | |
invoiceNumber | Character | Sim | tt-nota-fisc-adc.cod-nota-fisc | Número da Nota Fiscal | |
referDocumNumber | Character | Não | tt-nota-fisc-adc.cod-docto-referado | Número do Documento Referenciado | |
referDocumSeries | Character | Não | tt-nota-fisc-adc.cod-ser-docto-referado | Série do Documento Referenciado | |
referDocumIssuerCode | Integer | Não | tt-nota-fisc-adc.cdn-emit-docto-referado | Emitente do Documento Referenciado | |
referDocumModel | Character | Não | tt-nota-fisc-adc.cod-model-docto-referado | Modelo do Documento Referenciado | |
referDocumIssueDate | Date | Não | tt-nota-fisc-adc.dat-docto-referado | Data de Emissão do Documento Referenciado | |
referDocumKey | Character | Não | tt-nota-fisc-adc.cod-livre-2,1,60 | Chave do Documento Referenciado | |
operationTypeIndicator | Integer | Não | tt-nota-fisc-adc.idi-tip-docto-referado | Indicador do Tipo de Operação Onde: 01 = Entrada/Aquisição 02 = Saída/Prestação | |
billIssuerCode | Integer | Não | tt-nota-fisc-adc.idi-tip-emit-referado | Indicador de Emitente do Título Onde: | |
docStatusSefII | Integer | Não | tt-nota-fisc-adc.cod-livre-1,89,2 | Situação Documento (SEF II) Onde: 01 = Emissão Normal | |
totalValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,91,16 | Valor Total (SEF II) |
issValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,107,14 | Valor ISS (SEF II) |
issRetValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,121,14 | Valor ISS Retido (SEF II) |
icmsValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,135,14 | Valor ICMS (SEF II) |
icmstValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,149,14 | Valor ICMS ST (SEF II) |
anticipValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,163,14 | Valor Antecipado Trib Entr (SEF II) |
ipiValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,177,14 | Valor IPI (SEF II) |
transportValueSefII | Decimal | 2 | Não | tt-nota-fisc-adc.cod-livre-1,191,14 | Valor Transportado (SEF II) |
Obs.: Em cada requisição poderão ser enviadas uma ou mais notas para importação.
Layout da Resposta:
Campo | Tipo | Descrição |
siteID | Character | Estabelecimento |
series | Character | Série |
invoiceNumber | Character | Número da Nota Fiscal |
success | Logical | True se sucesso, False se falha |
Obs.: No final do processamento da importação das notas fiscais será retornada um array de objetos, sendo um objeto para cada nota fiscal enviada na requisição.
Possíveis Mensagens de Validações:
Nota Fiscal | Código | Mensagem |
0 | Importação realizada com sucesso | |
1 | Já existe ocorrência Nota Fiscal informada | |
2 | Não encontrado(a) Cliente/Fornec para chave informada | |
3 | O cliente informado para nota fiscal é um fornecedor | |
4 | Não encontrado(a) Estabelecimento para chave informada | |
5 | Unidade da Federação inexistente | |
6 | Natureza de operação não cadastrada | |
7 | Natureza de operação de Tipo Inválido | |
8 | Não encontrado(a) Série para chave informada | |
9 | Forma de emissão da série incorreta | |
10 | Canal de venda não cadastrado | |
11 | Condição de Pagamento não cadastrada | |
12 | Local de Entrega inexistente | |
13 | Não encontrado(a) Moeda para chave informada | |
14 | Não encontrado(a) Representante para chave informada | |
15 | Transportador inexistente | |
16 | Transportadora Redespacho inexistente | |
17 | Não encontrado(a) Tabela de Preço para chave informada | |
18 | Série de entrega futura não cadastrada | |
19 | Rota inexistente | |
20 | Mensagem inexistente | |
21 | Tabela de Financiamento inexistente | |
22 | Portador inexistente | |
23 | Não encontrado(a) Série para chave informada | |
24 | Não existem itens para a nota fiscal | |
25 | Duplicatas não foram geradas para a nota | |
Itens da Nota Fiscal | Código | Mensagem |
1 | Não existe Nota Fiscal para o Item | |
2 | Classificação Fiscal inexistente | |
3 | Não encontrado(a) Estabelecimento para chave informada | |
4 | Item inexistente | |
5 | Conta Contábil deve ser informada | |
6 | Referência do Item inexistente | |
7 | Natureza de Operação inexistente | |
8 | Natureza Complementar inexistente | |
9 | Quantidade deve ser maior que zero | |
10 | Não encontrado(a) Série para chave informada | |
11 | Não encontrado(a) Série Complementar para chave informada | |
12 | Unidade de Medida difere da do Item | |
13 | Unidade de Medida diferente da Unidade da Família | |
14 | Item não pertence a tabela de preços informada | |
15 | Preço Original deve ser maior ou igual a Preço Líquido | |
16 | Conta contábil inexistente | |
17 | Item sem saldo no estoque | |
18 | Quantidade do item difere da baixa do estoque | |
19 | Vl Mercadoria Liquido deve ser maior que zero | |
20 | Vl Mercadoria Original deve ser maior que zero | |
21 | Vl Mercadoria Tabela deve ser maior que zero | |
22 | Preço Liquido deve ser maior que zero | |
23 | Preço Original deve ser maior que zero | |
24 | Preço Tabela deve ser maior que zero | |
25 | Vl Total Item deve ser maior que zero | |
*26 | Chave Acesso NF-e\Situação NF-e\Tipo Emissão NF-e deve ser informado(a) | |
*27 | Situação NF-e inválida | |
*28 | Tipo Emissão NF-e inválido | |
* Obs.: Validações para importação de NF-e | ||
Notas de Transporte | Código | Mensagem |
1 | Não encontrado(a) Estabelecimento para chave informada | |
2 | Não encontrado(a) Série para chave informada | |
3 | Mensagem inexistente | |
Faturas da Nota Fiscal | Código | Mensagem |
1 | Código do vencimento inválido(a) | |
2 | Data de vencimento menor que data de emissão | |
3 | Natureza de Operação da Nota não gera faturamento | |
Representante | Código | Mensagem |
1 | Não encontrado(a) Representante para chave informada | |
Embalagem | Código | Mensagem |
1 | Não encontrado(a) Estabelecimento para chave informada | |
2 | Não encontrado(a) Série para chave informada | |
3 | Embalagem inexistente | |
Item da Embalagem | Código | Mensagem |
1 | Item inexistente | |
Itens Faturados por Lote/Série | Código | Mensagem |
1 | Item inexistente | |
2 | Depósito inexistente | |
3 | Localização inexistente | |
4 | Lote inexistente |
Exemplos JSON:
- JSON de Envio:
- Disponível na Collection Postman.
- Disponível na Collection Postman.
- JSON de resposta SUCESSO (HTTP Response Code = 200): quando ao menos uma das notas fiscais foi importada com sucesso.
- JSON de resposta ERRO (HTTP Response Code = 400): quando ocorreu erro em todas as notas fiscais a serem importadas.