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 | |
| obsnf | string(500) | |
| obs | string | |
| status | string(3) | |
| descnt_vlr | numeric(9,2) | |
| obscred | string | |
| id_intermed | string(2) | |
| libreg | string(5) | |
| libreg_obs | string | |
| 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 | |
| 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 | |
| id_fis_benef | string(10) |
/api/clientes
| Campo | Tipo | Observações |
|---|---|---|
| id | int | |
| lj | string(2) | |
| emp | string(3) | |
| nome | string(50) | |
| guerra | string(25) | |
| id_tipo | string(1) | |
| id_pessoa | string(1) | |
| id_contato | int | |
| id_pagto | int | |
| id_fpagto | int | |
| id_vended1 | int | |
| id_vended2 | int | |
| id_vended3 | int | |
| id_frete | int | |
| id_transp | int | |
| lj_transp | string(2) | |
| id_natfin | string(15) | |
| id_plano | string(20) | |
| id_grutri | int | |
| id_contrib | string(1) | |
| id_tabpre | int | |
| id_cidade | string(9) | |
| id_pais | int | |
| id_cnae | string(12) | |
| id_grupo | int | |
| id_regiao | int | |
| lj_cob | string(2) | |
| lj_ent | string(2) | |
| id_edi | string(20) | |
| dt_cad | date | |
| cnpj | string(18) | |
| ie | string(20) | |
| insmun | string(20) | |
| cnae | string(20) | |
| endereco | string(60) | |
| endnum | string(10) | |
| endcpl | string(60) | |
| cep | string(9) | |
| bairro | string(40) | |
| cidade | string(30) | |
| uf | string(2) | |
| ddd1 | string(5) | |
| fone1 | string(15) | |
| ddd2 | string(5) | |
| fone2 | string(15) | |
| fax_ddd | string(5) | |
| fax | string(15) | |
| contato | string(40) | |
| string(60) | ||
| email_nfe | string(60) | |
| site | string(40) | |
| comissao1 | numeric(9,2) | |
| comissao2 | numeric(9,2) | |
| comissao3 | numeric(9,2) | |
| icms | bool | |
| ipi | bool | |
| iss_ret | bool | |
| inss_ret | bool | |
| pis_ret | bool | |
| cofins_ret | bool | |
| csll_ret | bool | |
| ir_ali | numeric(9,2) | |
| lc_valor | numeric(9,2) | |
| lc_risco | string(1) | |
| lc_venc | date | |
| suframa_cod | string(15) | |
| suframa | string(2) | |
| inf_pri_com | date | |
| inf_ult_com | date | |
| inf_mai_com | numeric(9,2) | |
| inf_med_com | numeric(9,2) | |
| inf_num_com | int | |
| inf_mai_dup | numeric(9,2) | |
| inf_mai_atr | numeric(9,2) | |
| inf_med_atr | numeric(9,2) | |
| id_dis_regiao | int | |
| id_dis_veiculo | int | |
| dis_tempo | int | |
| dis_semana | string(7) | |
| dis_hora1 | string(5) | |
| dis_hora2 | string(5) | |
| dis_pontoref | string | |
| situac | string(1) | |
| dt_situac | date | |
| obs | string | |
| latitude | numeric(9,9) | |
| longitude | numeric(9,9) | |
| cnab_des_perc | numeric(9,2) | |
| cnab_des_praz | int | |
| icms_uf | string(1) | |
| dis_seq | int |
/api/produtos
| Campo | Tipo | Observações |
|---|---|---|
| id | string(20) | |
| emp | string(3) | |
| filial | string(2) | |
| nome | string(120) | |
| id_tipo | string(3) | |
| id_grupo1 | string(10) | |
| id_grupo2 | string(10) | |
| id_grupo3 | string(10) | |
| id_unidade | int | |
| id_embal | int | |
| id_armaz | string(3) | |
| id_ender | string(20) | |
| id_plano | string(20) | |
| id_centro | string(15) | |
| id_rateio | string(10) | |
| id_origem | string(1) | |
| id_clafis | string(10) | |
| id_cest | string(7) | |
| id_servico | string(5) | |
| id_servreinf | string(9) | |
| id_tme_ent | int | |
| id_tme_sai | int | |
| id_grutri | int | |
| id_edi | string(20) | |
| codbar | string(15) | |
| gtin | bool | |
| infadic | string | |
| obs | string | |
| met_custo | string(1) | |
| custo | numeric(9,4) | |
| margem | numeric(9,2) | |
| preco | numeric(9,4) | |
| precoc | numeric(9,4) | |
| dt_compra | date | |
| impost_dentro | numeric(9,2) | |
| impost_fora | numeric(9,2) | |
| peso_bru | numeric(9,4) | |
| peso_liq | numeric(9,4) | |
| qtde_emb | numeric(9,4) | |
| comp | numeric(9,2) | |
| larg | numeric(9,2) | |
| altu | numeric(9,2) | |
| comissao | numeric(9,2) | |
| classe | string(1) | |
| estseg | numeric(9,4) | |
| estmax | numeric(9,4) | |
| ponrep | numeric(9,4) | |
| temrep | int | |
| met_repos | string(1) | |
| met_requis | string(1) | |
| loteco | numeric(9,4) | |
| estvalid | string(1) | |
| lote | bool | |
| fant | bool | |
| nr_estr | string(2) | |
| modulo | string(2) | |
| tipi_ex | string(3) | |
| comb_anp | string(9) | |
| ipi_ali | numeric(9,2) | |
| icms_ivae | numeric(9,4) | |
| icms_ivas | numeric(9,4) | |
| iss | bool | |
| iss_ali | numeric(9,2) | |
| iss_red | numeric(9,2) | |
| iss_ativ | string(20) | |
| iss_cst | string(1) | |
| iss_local | string(1) | |
| inss | bool | |
| inss_ali | numeric(9,2) | |
| inss_red | numeric(9,2) | |
| ir | bool | |
| ir_ali | numeric(9,2) | |
| ir_red | numeric(9,2) | |
| img | bytea | |
| codbal | string(1) | |
| validade | int | |
| nr_rot | string(2) | |
| id_natfin | string(15) | |
| refugo | string(20) | |
| desp | numeric(9,2) | |
| id_regrat1 | string(20) | |
| id_regrat2 | string(20) | |
| id_regrat3 | string(20) |
Facebook