API
O sistema ERP Exsam possui uma API nativa para comunicação entre sistemas, por exemplo: consultar o estoque de um produto, alterar um cliente ou incluir um pedido de venda. A comunicação é realizada via protocolo HTTP e o formato JSON. Você receberá por e-mail informações de autenticação com a URL e um Token.
O pacote HTTP deve conter o método, a URL e os dados de autenticação, por exemplo:
GET /api/produtos
Content-Type: application/json
Authorization: Key token
A visualização dos dados é realizada pelo método GET, a inclusão pelo POST e a alteração pelo PUT.
Listagem: GET /api/rota. Obtém a listagem da rota. Para filtrar a listagem usar filtros como parâmetros da URL, por exemplo: /api/rota?dh_alt_gte=2024-10-31 15:35:00
Visualizar: GET /api/rota/id. Obtém o registro completo de uma rota.
Incluir: POST /api/rota. Enviar Body com o JSON do registro a ser incluso.
Alterar: PUT /api/rota/id. Enviar Body com o JSON das alterações correspondentes.
O campo chamado "id" é o identificador chave do registro, podendo ser do tipo serial (auto incremento), inteiro ou texto.
Os campos "emp" e "fil" guardam a indentificação da empresa e filial.
Os campos "dh_inc" e "dh_alt" guardam a data e hora de inclusão e última alteração do registro.
/api/pedidos
| Campo | Tipo | Observações |
|---|---|---|
| id | serial | Auto incremento. Será ignorado na inclusão. |
| num | string(10) | |
| emp | string(3) | |
| fil | string(3) | |
| id_tipo | string(3) | |
| clifor | string(1) | |
| id_agente | int | |
| lj_agente | string(2) | |
| id_agecob | int | |
| lj_agecob | string(2) | |
| id_ageent | int | |
| lj_ageent | string(2) | |
| id_ageret | int | |
| lj_ageret | string(2) | |
| id_remet | int | |
| lj_remet | string(2) | |
| id_exped | int | |
| lj_exped | string(2) | |
| id_receb | int | |
| lj_receb | string(2) | |
| id_seguro | int | |
| id_tipcli | string(1) | |
| id_atend | string(1) | |
| id_contato | int | |
| id_pagto | int | |
| id_fpagto | int | |
| id_tabpre | int | |
| id_vended1 | int | |
| id_vended2 | int | |
| id_vended3 | int | |
| id_frete | int | |
| id_transp | int | |
| lj_transp | string(2) | |
| id_usuario_inc | int | |
| id_usuario_bai | int | |
| id_origem | int | |
| origem | string(3) | |
| dt_cad | date | |
| dt_emissao | date | |
| dt_baixa | date | |
| comissao1 | numeric(9,2) | |
| comissao2 | numeric(9,2) | |
| comissao3 | numeric(9,2) | |
| parc_num | int | |
| parc_qtd | int | |
| vol_qtd | int | |
| vol_esp | string(15) | |
| vol_mar | string(15) | |
| vol_num | string(15) | |
| libest | bool | |
| dis_tipo | string(9) | |
| dis_serv | string(1) | |
| margem | numeric(9,2) | |
| peso_bru | numeric(9,4) | |
| peso_liq | numeric(9,4) | |
| desc_pct | numeric(9,2) | |
| desc_vlr | numeric(9,2) | |
| total_frete | numeric(9,2) | |
| total_seguro | numeric(9,2) | |
| total_despesa | numeric(9,2) | |
| total_prod | numeric(9,2) | |
| base_icms | numeric(9,2) | |
| total_icms | numeric(9,2) | |
| base_icms_st | numeric(9,2) | |
| total_icms_st | numeric(9,2) | |
| total_ipi | numeric(9,2) | |
| total_nota | numeric(9,2) | |
| chaves | string(1) | |
| obsnf | string(500) | |
| obs | string(1) | |
| status | string(3) | |
| descnt_vlr | numeric(9,2) | |
| obscred | string(1) | |
| id_intermed | string(2) | |
| libreg | string(5) | |
| libreg_obs | string(1) | |
| sep | bool |
Itens:
| Campo | Tipo | Observações |
|---|---|---|
| id | serial | Auto incremento. Será ignorado na inclusão. |
| emp | string(3) | |
| fil | string(3) | |
| item | int | |
| id_doc | int | |
| id_produto | string(20) | |
| id_produto2 | string(20) | |
| id_armaz | string(3) | |
| id_tme | int | |
| id_natope | string(4) | |
| id_excfis | int | |
| id_plano | string(20) | |
| id_centro | string(20) | |
| id_projeto | int | |
| id_ind | int | |
| id_ordpro | int | |
| id_unidade | int | |
| id_unidcom | int | |
| id_fci | string(36) | |
| id_original | int | |
| original_mod | string(1) | |
| original | string(50) | |
| origem | string(3) | |
| id_origem | int | |
| produto | string(120) | |
| infadic | string(1) | |
| dt_entrega | date | |
| qtde | numeric(9,4) | |
| qtdec | numeric(9,4) | |
| saldo | numeric(9,4) | |
| saldoc | numeric(9,4) | |
| resid | numeric(9,4) | |
| residc | numeric(9,4) | |
| preco | numeric(9,4) | |
| precob | numeric(9,4) | |
| total | numeric(9,2) | |
| totnf | numeric(9,2) | |
| totbc | numeric(9,2) | |
| impost | numeric(9,2) | |
| custo | numeric(9,2) | |
| margem | numeric(9,2) | |
| age_doc | string(20) | |
| age_pro | string(20) | |
| desc_pct | numeric(9,2) | |
| desc_vlr | numeric(9,2) | |
| descnt_pct | numeric(9,2) | |
| descnt_vlr | numeric(9,2) | |
| descnt_mot | string(3) | |
| iptman | bool | |
| icms | numeric(9,2) | |
| icms_cst | string(4) | |
| icms_red | numeric(9,4) | |
| icms_bas | numeric(9,2) | |
| icms_vlr | numeric(9,2) | |
| icms_st_iva | numeric(9,4) | |
| icms_st_bas | numeric(9,2) | |
| icms_st_vlr | numeric(9,2) | |
| icms_intra | numeric(9,2) | |
| icms_da | numeric(9,2) | |
| icms_da_bas | numeric(9,2) | |
| icms_da_vlr | numeric(9,2) | |
| icms_da_rem | numeric(9,2) | |
| fcp_vlr | numeric(9,2) | |
| fcp_st | numeric(9,2) | |
| ipi | numeric(9,2) | |
| ipi_cst | string(2) | |
| ipi_bas | numeric(9,2) | |
| ipi_vlr | numeric(9,2) | |
| pis | numeric(9,4) | |
| pis_cst | string(2) | |
| pis_bas | numeric(9,2) | |
| pis_vlr | numeric(9,2) | |
| cofins | numeric(9,4) | |
| cofins_cst | string(2) | |
| cofins_bas | numeric(9,2) | |
| cofins_vlr | numeric(9,2) | |
| peso_bru | numeric(9,4) | |
| peso_liq | numeric(9,4) | |
| frete | numeric(9,2) | |
| seguro | numeric(9,2) | |
| despesa | numeric(9,2) | |
| comissao1 | numeric(9,2) | |
| comissao2 | numeric(9,2) | |
| comissao3 | numeric(9,2) | |
| flag | int | |
| status | string(3) | |
| fcp | numeric(9,2) | |
| fcp_bas | numeric(9,2) | |
| ipi_dev | numeric(9,2) | |
| id_regrat1 | string(20) | |
| id_regrat2 | string(20) | |
| id_regrat3 | string(20) | |
| export | string(1) | |
| id_fis_benef | string(10) |
/api/clientes
| Campo | Tipo | Observações |
|---|---|---|
| id | int | Código do cliente |
| lj | string(2) | Código da loja |
| emp | string(3) | Código da empresa |
| nome | string(50) | Nome do cliente |
| guerra | string(25) | Nome fantasia |
| id_tipo | string(1) | Código do tipo de cliente. Domínios: {R-Revendedor, F-Cons.Final, X-Exportação} |
| id_pessoa | string(1) | Código pessoa. Domínios: {J-Jurídica, F-Física, E-Estrangeira} |
| id_contato | int | Código contato |
| id_pagto | int | Código pagamento |
| id_fpagto | int | Código forma pagamento |
| id_vended1 | int | Código vendedor 1 |
| id_vended2 | int | Código vendedor 2 |
| id_vended3 | int | Código vendedor 3 |
| id_frete | int | Código frete |
| id_transp | int | Código transportadora |
| lj_transp | string(2) | Código loja transportadora |
| id_natfin | string(15) | Código natureza financeira |
| id_plano | string(20) | Código plano financeiro |
| id_grutri | int | Código grupo tributário |
| id_contrib | string(1) | Código contribuinte. Domínios: {C-Contribuinte, N-Não Contribuinte, S-Simples} |
| id_tabpre | int | Código tabela de preços |
| id_cidade | string(9) | Código cidade |
| id_pais | int | Código país |
| id_cnae | string(12) | Código CNAE |
| id_grupo | int | Código grupo |
| id_regiao | int | Código região |
| lj_cob | string(2) | Código loja cobrança |
| lj_ent | string(2) | Código loja entrega |
| id_edi | string(20) | Código EDI |
| dt_cad | date | Data de cadastro |
| cnpj | string(18) | CNPJ |
| ie | string(20) | Inscrição estadual |
| insmun | string(20) | Inscrição municipal |
| cnae | string(20) | Descrição do CNAE |
| endereco | string(60) | Endereço |
| endnum | string(10) | Número do endereço |
| endcpl | string(60) | Complemento do endereço |
| cep | string(9) | CEP |
| bairro | string(40) | Bairro |
| cidade | string(30) | Cidade |
| uf | string(2) | Estado |
| ddd1 | string(5) | DDD telefone principal |
| fone1 | string(15) | Telefone principal |
| ddd2 | string(5) | DDD telefone secundário |
| fone2 | string(15) | Telefone secundário |
| fax_ddd | string(5) | DDD fax |
| fax | string(15) | Número do fax |
| contato | string(40) | Nome do contato |
| string(60) | ||
| email_nfe | string(60) | Email NFe |
| site | string(40) | Site do cliente |
| comissao1 | numeric(9,2) | Comissão vendedor 1 |
| comissao2 | numeric(9,2) | Comissão vendedor 2 |
| comissao3 | numeric(9,2) | Comissão vendedor 3 |
| icms | bool | Indicador de ICMS |
| ipi | bool | Indicador de IPI |
| iss_ret | bool | Indicador retenção ISS |
| inss_ret | bool | Indicador retenção INSS |
| pis_ret | bool | Indicador retenção PIS |
| cofins_ret | bool | Indicador retenção COFINS |
| csll_ret | bool | Indicador retenção CSLL |
| ir_ali | numeric(9,2) | Alíquota IR |
| lc_valor | numeric(9,2) | Valor limite de crédito |
| lc_risco | string(1) | Classificação risco cliente. Domínios: {A-Liberado, B-Atraso G (10), C-Atraso M (5), D-Atraso P (1), X-Bloqueado, Z-Manual} |
| lc_venc | date | Vencimento limite crédito |
| suframa_cod | string(15) | Código SUFRAMA. Domínios: {0-Não, S1-ICMS+PIS, S2-ICMS, S3-Pis/Cofins} |
| suframa | string(2) | Indicador SUFRAMA |
| inf_pri_com | date | Data primeira compra |
| inf_ult_com | date | Data última compra |
| inf_mai_com | numeric(9,2) | Maior valor de compra |
| inf_med_com | numeric(9,2) | Valor médio de compra |
| inf_num_com | int | Número de compras |
| inf_mai_dup | numeric(9,2) | Maior duplicata |
| inf_mai_atr | numeric(9,2) | Maior valor em atraso |
| inf_med_atr | numeric(9,2) | Valor médio em atraso |
| id_dis_regiao | int | Código região distribuição |
| id_dis_veiculo | int | Código veículo distribuição |
| dis_tempo | int | Tempo de distribuição |
| dis_semana | string(7) | Dias da semana para distribuição |
| dis_hora1 | string(5) | Horário inicial distribuição |
| dis_hora2 | string(5) | Horário final distribuição |
| dis_pontoref | string(1) | Ponto de referência distribuição |
| situac | string(1) | Situação. Domínios: {A-Ativo, I-Inativo, B-Bloqueado} |
| dt_situac | date | Data situação |
| obs | string(1) | Observações |
| latitude | numeric(9,9) | Latitude |
| longitude | numeric(9,9) | Longitude |
| cnab_des_perc | numeric(9,2) | Percentual desconto CNAB |
| cnab_des_praz | int | Prazo desconto CNAB |
| icms_uf | string(1) | Indicador ICMS por UF. Domínios: {N-Normal, E-Entrega} |
| dis_seq | int | Sequência distribuição |
| dh_inc | timestamp | Data/hora inclusão |
| dh_alt | timestamp | Data/hora alteração |
| cob_aviso | int | Indicador aviso cobrança |
/api/produtos
| Campo | Tipo | Observações |
|---|---|---|
| id | string(20) | Código do produto |
| emp | string(3) | Código da empresa vinculada ao produto |
| filial | string(2) | Código da filial vinculada ao produto |
| nome | string(120) | Descrição do produto |
| id_tipo | string(3) | Código do tipo do produto. Domínios: {00-Mercadoria p/Revenda, 01-Matéria Prima, 02-Embalagem, 03-Produto em Processo, 04-Produto Acabado, 05-Subproduto, 06-Produto Intermediário, 07-Material de Consumo, 08-Ativo Imobilizado, 09-Serviços, 10-Outros Insumos, 99-Outros} |
| id_grupo1 | string(10) | Código do grupo principal de classificação |
| id_grupo2 | string(10) | Código do subgrupo de classificação |
| id_grupo3 | string(10) | Código do subnível adicional de classificação |
| id_unidade | int | Código da unidade de medida de estoque |
| id_embal | int | Código da unidade de embalagem comercial |
| id_armaz | string(3) | Código do armazém padrão de movimentação |
| id_ender | string(20) | Código do endereço físico para controle por localização |
| id_plano | string(20) | Código da conta contábil vinculada |
| id_centro | string(15) | Código do centro de custo padrão |
| id_rateio | string(10) | Código da regra de rateio contábil |
| id_origem | string(1) | Código da origem da mercadoria. Domínios: {0-Nacional, exceto 3,4,5,8; 1-Estrangeira Importação direta, exceto 6; 2-Estrangeira adquirida no mercado interno, exceto 7; 3-Nacional CI 40% a 70%; 4-Nacional conforme PPB; 5-Nacional CI até 40%; 6-Estrangeira Importação direta sem similar nacional; 7-Estrangeira adquirida mercado interno sem similar nacional; 8-Nacional CI superior a 70%} |
| id_clafis | string(10) | Código do NCM ou classificação fiscal |
| id_cest | string(7) | Código CEST para substituição tributária |
| id_servico | string(5) | Código do serviço conforme LC 116 |
| id_servreinf | string(9) | Código do serviço conforme tabela REINF |
| id_tme_ent | int | Código do TME padrão para entrada |
| id_tme_sai | int | Código do TME padrão para saída |
| id_grutri | int | Código do grupo de tributação para exceções fiscais |
| id_edi | string(20) | Código EDI ou integração externa |
| codbar | string(15) | Código de barras do produto |
| gtin | bool | Indica se o código de barras é GTIN válido |
| infadic | string(1) | Informações adicionais fiscais enviadas no XML |
| obs | string(1) | Observações internas do produto |
| met_custo | string(1) | Método de cálculo de custo. Domínios: {0-Médio, 2-Manual} |
| custo | numeric(9,4) | Custo unitário do produto |
| margem | numeric(9,2) | Margem de lucro aplicada na formação do preço |
| preco | numeric(9,4) | Preço de venda calculado ou informado |
| precoc | numeric(9,4) | Preço de venda complementar ou promocional |
| dt_compra | date | Data da última compra realizada |
| impost_dentro | numeric(9,2) | % impostos inclusos no preço |
| impost_fora | numeric(9,2) | % impostos calculados fora do preço |
| peso_bru | numeric(9,4) | Peso bruto unitário em kg |
| peso_liq | numeric(9,4) | Peso líquido unitário em kg |
| qtde_emb | numeric(9,4) | Quantidade de unidades por embalagem |
| comp | numeric(9,2) | Comprimento do produto em cm |
| larg | numeric(9,2) | Largura do produto em cm |
| altu | numeric(9,2) | Altura do produto em cm |
| comissao | numeric(9,2) | % de comissão específica do produto |
| classe | string(1) | Classificação ABC (A, B ou C) |
| estseg | numeric(9,4) | Estoque de segurança mínimo |
| estmax | numeric(9,4) | Estoque máximo recomendado |
| ponrep | numeric(9,4) | Ponto de reposição automático |
| temrep | int | Tempo de reposição em dias |
| met_repos | string(1) | Método de reposição. Domínios: {0-Manual, 1-MRP, 2-Encomenda, 3-Industrialização} |
| met_requis | string(1) | Método de requisição. Domínios: {0-Manual, 1-Automático} |
| loteco | numeric(9,4) | Lote econômico de reposição |
| estvalid | string(1) | Validação de estoque. Domínios: {0-Nenhuma, 1-Saldo Negativo, 2-Custo Inválido, 3-Saldo e Custo} |
| lote | bool | Controla rastreabilidade por lote |
| fant | bool | Indica se o produto é kit fantasma |
| nr_estr | string(2) | Número de níveis da estrutura produtiva |
| modulo | string(2) | Módulos permitidos para movimentação. Domínios: {01-Compra, 02-Venda, 03-Assistida, 05-Serviço, 09-Interno, 11-Exceto Compra, 12-Exceto Venda, 13-Exceto Assistida, 15-Exceto Serviço, 19-Exceto Interno, 51-Compra/Venda, 52-Compra/Interno, 53-Venda/Interno, 98-Inativo, 99-Todos} |
| tipi_ex | string(3) | Exceção TIPI vinculada ao NCM |
| comb_anp | string(9) | Código ANP para combustíveis |
| ipi_ali | numeric(9,2) | Alíquota de IPI do produto |
| icms_ivae | numeric(9,4) | IVA para ICMS-ST na entrada |
| icms_ivas | numeric(9,4) | IVA para ICMS-ST na saída |
| iss | bool | Indica se o item é serviço sujeito a ISS |
| iss_ali | numeric(9,2) | Alíquota de ISS |
| iss_red | numeric(9,2) | % Redução da base de cálculo do ISS |
| iss_ativ | string(20) | Código da atividade de serviço municipal |
| iss_cst | string(1) | CST do ISS conforme município |
| iss_local | string(1) | Indica incidência no prestador ou tomador |
| inss | bool | Indica retenção de INSS |
| inss_ali | numeric(9,2) | Alíquota de INSS |
| inss_red | numeric(9,2) | % Redução base INSS |
| ir | bool | Indica retenção de IRRF |
| ir_ali | numeric(9,2) | Alíquota de IRRF |
| ir_red | numeric(9,2) | % Redução base IRRF |
| img | bytea | Imagem ilustrativa do produto |
| codbal | string(1) | Indica o código da balança. Domínios: {N-Não, T-Total, Q-Quantidade} |
| validade | int | Prazo de validade em dias |
| nr_rot | string(2) | Número do roteiro de produção |
| id_natfin | string(15) | Código da natureza financeira padrão vinculada |
| refugo | string(20) | Configuração de tratamento de refugo |
| desp | numeric(9,2) | % Despesas adicionais para formação de preço |
| id_regrat1 | string(20) | Código da regra tributária 1 vinculada |
| id_regrat2 | string(20) | Código da regra tributária 2 vinculada |
| id_regrat3 | string(20) | Código da regra tributária 3 vinculada |
| dh_inc | timestamp | Data e hora de inclusão do registro |
| dh_alt | timestamp | Data e hora da última alteração |
| nbs | string(10) | NBS |
| cct | string(6) | Código CCT para controle de crédito tributário |
/api/notas
| Campo | Tipo | Observações |
|---|---|---|
| id | int | Identificador do documento |
| num | string(9) | Número do documento |
| ser | string(3) | Série do documento |
| mod | string(3) | Modelo do documento. Exemplos: 55 - NF-e, 65 - NFC-e |
| emp | string(3) | Código da empresa |
| fil | string(3) | Código da filial |
| id_tipo | string(1) | Tipo do documento. Domínios: {N-Normal, P-Pedido, D-Devolução, C-Complemento, B-Fornecedor} |
| id_origem | string(10) | Identificador da origem do documento. Domínios: {LBE - Liberação de Estoque, PDV - Pedido de Venda} |
| nr_origem | string(3) | Número da origem do documento |
| id_emitente | string(1) | Código da filial que emitiu o documento |
| clifor | string(1) | Tipo do agente. Domínios: {C-Cliente, F-Fornecedor} |
| id_agente | string(2) | Código do cliente ou fornecedor do faturamento |
| lj_agente | int | Loja do agente |
| id_agecob | string(2) | Identificador do agente de cobrança |
| lj_agecob | int | Loja do agente de cobrança |
| id_ageent | string(2) | Identificador do agente de entrega |
| lj_ageent | int | Loja do agente de entrega |
| id_ageret | string(2) | Identificador do agente de retorno (se aplicável) |
| lj_ageret | int | Loja do agente de retorno |
| id_remet | string(2) | Identificador do remetente |
| lj_remet | int | Loja do remetente |
| id_exped | string(2) | Identificador da expedição |
| lj_exped | int | Loja da expedição |
| id_receb | string(1) | Identificador do recebedor |
| lj_receb | string(1) | Loja do recebedor |
| id_seguro | string(1) | Identificador do seguro vinculado à operação |
| id_tipcli | string(1) | Tipo do cliente. Domínios: {R-Revendedor, I-Industrializador, F-Cons. Final, X-Exportação} |
| id_contrib | string(1) | Indica se é contribuinte ou não do ICMS. Domínios: {C-Contribuinte, N-Não Contribuinte, S-Simples} |
| id_atend | int | Identificador do responsável pelo atendimento |
| id_pagto | int | Identificador da condição de pagamento |
| id_fpagto | string(2) | Identificador da forma de pagamento |
| id_frete | int | Identificador do tipo de frete |
| id_transp | int | Identificador do transportador |
| lj_transp | string(1) | Loja do transportador |
| id_mensag | string(60) | Identificador de mensagem associada |
| id_nfe | string(50) | Chave de acesso da NF-e |
| origem | string(18) | Nome da origem do documento (LBE - Liberação de Estoque, PED - Pedido de Venda) |
| natope | string(20) | Natureza da operação fiscal |
| nome | string(60) | Nome do destinatário |
| cnpj | string(14) | CNPJ do destinatário |
| ie | string(14) | Inscrição estadual do destinatário |
| endereco | string(60) | Logradouro do destinatário |
| endnum | string(10) | Número do endereço do destinatário |
| endcpl | string(20) | Complemento do endereço |
| cep | string(8) | CEP do destinatário |
| bairro | string(40) | Bairro do destinatário |
| uf | string(2) | UF do destinatário |
| dh_emissao | timestamp | Data/hora de emissão do documento |
| dh_mov | timestamp | Data/hora de movimentação do documento |
| dh_libcred | timestamp | Data/hora de liberação de crédito |
| parc_num | int | Número da parcela |
| parc_qtd | int | Quantidade de parcelas |
| tra_nome | string(60) | Nome do transportador |
| tra_cnpj | string(14) | CNPJ do transportador |
| tra_ie | string(14) | Inscrição estadual do transportador |
| tra_endereco | string(60) | Endereço do transportador |
| tra_cidade | string(40) | Cidade do transportador |
| tra_uf | string(2) | Estado do transportador |
| placa_nr | string(7) | Número da placa do veículo |
| placa_uf | string(2) | UF da placa do veículo |
| vol_qtd | int | Quantidade de volumes |
| vol_esp | string(30) | Espécie dos volumes |
| vol_mar | string(30) | Marca dos volumes |
| vol_num | string(30) | Numeração dos volumes |
| dis_tipo | string(30) | Tipo de serviço de distribuição |
| dis_serv | string(30) | Serviço de distribuição contratado |
| dis_toma | string(1) | Tomador do serviço de frete |
| peso_bru | numeric(10,2) | Peso bruto da mercadoria |
| peso_liq | numeric(10,2) | Peso líquido da mercadoria |
| desc_pct | numeric(5,2) | Percentual de desconto aplicado |
| desc_vlr | numeric(12,2) | Valor total de desconto |
| total_frete | numeric(12,2) | Valor total do frete |
| total_seguro | numeric(12,2) | Valor total do seguro |
| total_despesa | numeric(12,2) | Outras despesas acessórias |
| total_prod | numeric(12,2) | Total dos produtos |
| base_icms | numeric(12,2) | Base de cálculo do ICMS |
| total_icms | numeric(12,2) | Valor total do ICMS |
| base_icms_st | numeric(12,2) | Base de cálculo do ICMS ST |
| total_icms_st | numeric(12,2) | Valor total do ICMS ST |
| total_ipi | numeric(12,2) | Valor total do IPI |
| total_nota | numeric(14,2) | Valor total da nota |
| chaves | text | Chave de acesso da NF-e |
| mensag | text | Mensagem ou observações gerais |
| status | string(1) | Status do documento. Domínios: {PEN-Pendente, FAT-Faturado, CAN-Cancelado} |
| statusd | string(30) | Status do documento na Ordem Distribuição. Domínios: {PEN-Pendente, LIB-Liberado, BAI-Baixado} |
| id_contato | int | Identificador do contato |
| mensagf | text | Mensagem ou observação fiscal |
| id_munic | string(7) | Código do município do destinatário |
| descnt_vlr | numeric(12,2) | Valor de desconto adicional |
| frete_ent | numeric(12,2) | Valor do frete de entrega |
| id_intermed | string(30) | Identificador do intermediador da operação |
| docexp | string(10) | Número do documento de exportação |
| id_munic1 | string(7) | Código auxiliar de município |
| id_munic2 | string(7) | Código auxiliar de município 2 (se houver) |
| dh_inc | timestamp | Data/hora de inclusão do registro |
| dh_alt | timestamp | Data/hora da última alteração |
| ent_cep | string(8) | CEP do endereço de entrega |
| ent_endereco | string(60) | Endereço de entrega (logradouro) |
| ent_endnum | string(10) | Número do endereço de entrega |
| ent_endcpl | string(20) | Complemento do endereço de entrega |
| ent_bairro | string(40) | Bairro do endereço de entrega |
| ent_id_munic | string(7) | Código do município de entrega |
| ent_uf | string(2) | Estado do endereço de entrega |
| pedidos | text | Referência aos pedidos vinculados |
Itens:
| Campo | Tipo | Observações |
|---|---|---|
| id | int | Identificador do item |
| emp | string(3) | Código da empresa |
| fil | string(3) | Código da filial da empresa |
| item | int | Número do item na nota |
| id_doc | int | Identificador do documento relacionado |
| id_ped_item | int | Identificador do item do pedido relacionado |
| id_lib_item | int | Identificador do item liberado |
| id_notares | int | Identificador da nota de ressarcimento |
| id_produto | string(20) | Código do produto |
| id_produto2 | string(20) | Código do produto 2 |
| id_armaz | string(3) | Código do armazém de estoque |
| id_tme | int | Código do TME |
| id_plano | string(20) | Código do plano contábil |
| id_natope | string(4) | Código da natureza da operação |
| id_excfis | int | Código da exceção fiscal aplicada |
| id_centro | string(20) | Código do centro de custo |
| id_projeto | int | Código do projeto associado |
| id_ind | int | Identificador do indicador |
| id_ordpro | int | Identificador da ordem de produção |
| id_unidade | int | Código da unidade de estoque |
| id_unidcom | int | Código da unidade comercial |
| id_fci | string(36) | Código do FCI (Ficha de Conteúdo de Importação) |
| id_original | int | Código do documento original para referência |
| original_mod | string(1) | Indicador do modelo do documento original |
| original | string(50) | Número do documento original |
| id_vended1 | int | Código do vendedor principal |
| id_vended2 | int | Código do segundo vendedor |
| id_vended3 | int | Código do terceiro vendedor |
| produto | string(120) | Nome do produto |
| infadic | text | Informações adicionais sobre o item |
| dt_liberacao | date | Data de liberação do item |
| dt_entrega | date | Data prevista de entrega |
| qtde | numeric(15,4) | Quantidade do produto na nota |
| qtdec | numeric(15,4) | Quantidade com casa decimal detalhada |
| preco | numeric(15,4) | Preço unitário do produto |
| precob | numeric(15,2) | Preço base cobrado |
| total | numeric(12,2) | Valor total do item (quantidade x preço) |
| totnf | numeric(12,2) | Total na nota fiscal para o item |
| totbc | numeric(15,2) | Total da base de cálculo do item |
| totlq | numeric(12,2) | Total líquido após descontos e acréscimos |
| impost | numeric(12,2) | Valor total dos impostos incidentes |
| custo1 | numeric(20,2) | Custo na moeda principal |
| custo2 | numeric(20,2) | Custo na moeda secundária (se houver) |
| custo3 | numeric(20,2) | Custo na moeda terceária (se houver) |
| age_doc | string(20) | Código do pedido do cliente |
| age_pro | string(20) | Código do cliente |
| desc_pct | numeric(5,2) | Percentual de desconto aplicado |
| desc_vlr | numeric(12,2) | Valor do desconto Suframa |
| descnt_pct | numeric(9,2) | Percentual de desconto adicional |
| descnt_vlr | numeric(12,2) | Valor do desconto adicional |
| descnt_mot | string(3) | Motivo do desconto adiciona |
| iptman | boolean | Indicador se o imposto é manual. |
| icms | numeric(9,2) | Valor do ICMS (Imposto sobre Circulação de Mercadorias e Serviços). |
| icms_cst | string(4) | Código da situação tributária do ICM |
| icms_fis | string(1) | Código fiscal do ICMS (físico) |
| icms_red | numeric(9,4) | Percentual de redução da base de cálculo do ICMS |
| icms_bas | numeric(12,2) | Base de cálculo do ICMS |
| icms_vlr | numeric(12,2) | Valor do ICMS calculado |
| icms_st_iva | numeric(9,4) | Percentual do ICMS-ST (Substituição Tributária) do IVA |
| icms_st_bas | numeric(12,2) | Base de cálculo do ICMS-ST |
| icms_st_vlr | numeric(12,2) | Valor do ICMS-ST |
| icms_ret_bas | numeric(12,2) | Base de cálculo do ICMS retido |
| icms_ret_vlr | numeric(9,2) | Valor do ICMS retido |
| icms_intra | numeric(9,2) | Valor do ICMS intraestadual |
| icms_da | numeric(12,2) | Valor do diferencial de alíquota do ICMS |
| icms_da_bas | numeric(12,2) | Base de cálculo do diferencial de alíquota do ICMS |
| icms_da_vlr | numeric(12,2) | Valor do diferencial de alíquota calculado |
| icms_da_rem | numeric(15,2) | Valor do diferencial de alíquota remetido |
| fcp_vlr | numeric(15,2) | Valor do Fundo de Combate à Pobreza (FCP) |
| fcp_st | numeric(9,2) | Valor do FCP na Substituição Tributária |
| ipi | string(2) | Código do IPI (Imposto sobre Produtos Industrializados) |
| ipi_cst | numeric(12,2) | Código da situação tributária do IPI |
| ipi_bas | numeric(12,2) | Base de cálculo do IPI |
| ipi_vlr | numeric(9,2) | Valor do IPI |
| iss | string(1) | Código do ISS (Imposto sobre Serviços) |
| iss_cst | numeric(12,2) | Código da situação tributária do ISS |
| iss_bas | numeric(12,2) | Base de cálculo do ISS |
| iss_vlr | numeric(12,4) | Valor do ISS |
| pis | string(2) | Código do PIS (Programa de Integração Social) |
| pis_cst | string(6) | Código da situação tributária do PIS |
| pis_natrec | numeric(12,2) | Natureza da receita para o PIS |
| pis_bas | numeric(12,2) | Base de cálculo do PIS |
| pis_vlr | numeric(12,4) | Valor do PIS |
| cofins | string(2) | Código do COFINS (Contribuição para o Financiamento da Seguridade Social) |
| cofins_cst | string(6) | Código da situação tributária do COFINS |
| cofins_natrec | numeric(12,2) | Natureza da receita para o COFINS |
| cofins_bas | numeric(12,2) | Base de cálculo do COFINS |
| cofins_vlr | numeric(15,4) | Valor do COFINS |
| peso_bru | numeric(15,4) | Peso bruto do item |
| peso_liq | numeric(12,2) | Peso líquido do item |
| frete | numeric(12,2) | Valor do frete relacionado ao item |
| seguro | numeric(9,2) | Valor do seguro relacionado ao item |
| despesa | numeric(9,2) | Outras despesas relacionadas ao item |
| comissao1 | numeric(9,2) | Comissão do vendedor 1 |
| comissao2 | numeric(15,2) | Comissão do vendedor 2 |
| comissao3 | numeric(15,2) | Comissão do vendedor 3 |
| fcp | numeric(15,2) | Valor do Fundo de Combate à Pobreza (FCP) |
| fcp_bas | string(20) | Base de cálculo para o FCP |
| ipi_dev | string(20) | Código de devolução do IPI |
| custo | string(20) | Campo para custo adicional (uso específico) |
| id_regrat1 | numeric(15,4) | Código do departamento (se houver) |
| id_regrat2 | numeric(15,2) | Código do projeto (se houver) |
| id_regrat3 | text | Código 3º Regra de Rateio (se houver) |
| icms_diferim | string(10) | Código para ICMS diferido |
| icms_diferim_vlr | numeric(9,2) | Valor do ICMS diferido |
| export | numeric(12,2) | Valor referente à exportação |
| id_fis_benef | string(10) | Código do benefício fiscal |
| icms_st_red | string(10) | Código para redução do ICMS-ST |
| icms_ret_subst | numeric(15,4) | Valor do ICMS retido por substituição tributária |
| ncm | int | Código NCM (Nomenclatura Comum do Mercosul) do produto |
| nbs | string(6) | Código NBS (Nomenclatura Brasileira de Serviços) |
| qtdet | string(1) | Indicador de quantidade (uso específico) |
| id_unidtrib | numeric(15,2) | Unidade tributária associada ao item |
| cct | numeric(9,4) | Código da Classificação Tributária |
| trib | numeric(15,2) | Valor total tributário |
| bas | numeric(9,4) | Base de cálculo geral |
| cbs | numeric(9,4) | Base de cálculo do CBS |
| cbs_vlr | numeric(15,2) | Valor do CBS |
| cbs_red | numeric(9,4) | Número de redução do CBS |
| ibs_uf | numeric(9,4) | Base do IBS estadual |
| ibs_uf_vlr | numeric(15,2) | Valor do IBS estadual |
| ibs_uf_red | numeric(9,4) | Redução do IBS estadual |
| ibs_mun | numeric(9,4) | Base do IBS municipal |
| ibs_mun_vlr | numeric(15,2) | Valor do IBS municipal |
| ibs_mun_red | numeric(9,4) | Redução do IBS municipal |
| is_cct | string(6) | Código do IS |
| is_bas | numeric(15,2) | Base de cálculo do IS |
| is_ali | numeric(9,4) | Alíquota do IS |
| is_ali_qt | numeric(9,4) | Alíquota quantitativa do IS |
| is_vlr | numeric(15,2) | Valor do IS |

Facebook