Documentação da API

Entry point: None

Clientes

POST

/clientes Insere ou atualiza os clientes da aplicação recebidos pela array com os clientes no body

Insere ou atualiza os clientes da aplicação recebidos pela array com os clientes no body

None/clientes

Headers

Content-Type	application/json

Body

cnpj *	string	CNPJ da empresa que está fazendo a importação
formato *	string	Formato do documento recebido na requisição da importação
conteudo *	string	Conteúdo a ser recebido pela importação

[
    {
        "cnpj": "12.345.678/9012-34",
        "conteudo": "control:CL1;id_erp:1;intv:0;tipo:F;fant_apel:Jo\u00e3o Vitor;raz_nome: Jo\u00e3o Vitor Soares Rezende;cnpj_cpf:011.245.785-11;cep:37200-413;logr:Rua Francisco;num:100;compl:Apto 201;bairro:Centro;cid:Lavras;est:MG;email:dev.joao.rezende@progenbr.com;id_erp_cond:1;desc_cond:Parcelado;tel:35 999933-6699;|\u014b|control:CL1;id_erp:2;intv:0;tipo:J;fant_apel:ProgenBR;raz_nome:Progen Brasil Tecnologia LTDA;cnpj_cpf:37.856.916/0001-58;cep:14090-280;logr:Rua Dom Lu\u00eds do Amaral Mousinho;num:754;bairro:Jardim Paulistano;cid:Ribeir\u00e3o Preto;est:SP;email:contato@progenbr.com,progen.cotacao@gmail.com;id_erp_cond:2;desc_cond:A vista;tel:(99) 99999-9999,(16) 3967-3169;ie:797.621.321.113",
        "formato": "txt"
    }
]

Response

201

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da operação de importação
importados	number	Quantidade de clientes importados
msg_atencao	string	Mensagem de atenção sobre algo na operação
conteudo	string	Mensagem da importação

401

Campo	Tipo de dado	Descrição
message	string	message com o erro de autenticação

500

Campo	Tipo de dado	Descrição
message	string	message com a descrição do erro

Entradas

POST

/entradas Insere ou atualiza as entradas do importador da aplicação recebidos pela array com as entradas no body

Insere ou atualiza as entradas do importador da aplicação recebidos pela array com as entradas no body

None/entradas

Headers

Content-Type	application/json

Body

cnpj *	string	CNPJ de quem está fazendo a importação
formato *	string	Formato do conteúdo recebido
conteudo *	string	Conteúdo a ser enviado para a importação

[
    {
        "cnpj": "00.000.000/0000-00",
        "conteudo": "numero_entrada:1;cnpj_loja:00.000.000/0000-00;id_erp_forn:9;data_inclusao:2023-12-11;total:1287.99;numero_nota:524;id_tipo_movimento:2;id_pedido_compra:16;numero_serie:002;status:2;cfop:5402;tipo_entrada:1;id_erp_user:20;data_conclusao:2023-12-11|@|id_item:1;id_erp_prod:9;custo_unitario:4.00;custo_medio_entrada:4.124533;quantidade:10;custo_embalagem:16.00;qtd_embalagem:4;embalagem:kg\nnumero_entrada:1;cnpj_loja:00.000.000/0000-00;id_erp_forn:10;data_inclusao:2023-12-11;total:1287.99;numero_nota:524;numero_serie:002;status:2;cfop:5402;tipo_entrada:1;id_erp_user:20;data_conclusao:2023-12-11;conferido_appone:False|@|id_item:4;id_erp_prod:9;custo_unitario:90.00;custo_medio_entrada:4.574;quantidade:15;custo_embalagem:6.00;qtd_embalagem:1;embalagem:un",
        "formato": "txt"
    }
]

Response

201

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação
importados	number	Quantidade de importações realizadas
msg_atencao	string	Mensagem caso ocorra algum erro na importação
conteudo	string	Mensagem sobre o resultado da importação

401

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação
erro	string	Descrição do erro
conteudo	string

[{'resultado': 4, 'qtd_recebida': 4, 'qtd_salva': 4}]

Fornecedores

POST

/fornecedores Insere ou atualiza os fornecedores do importador da aplicação recebidos pela array com os fornecedores no body

Insere ou atualiza os fornecedores do importador da aplicação recebidos pela array com os fornecedores no body

None/fornecedores

Headers

Content-Type	application/json

Body

cnpj *	string	CNPJ de quem está fazendo a importação
formato *	string	Formato do conteúdo recebido
conteudo *	string	Conteúdo a ser enviado para a importação

[
    {
        "cnpj": "12.345.678/9012-34",
        "conteudo": "control:F1;id_erp:1;intv:0;fant:Teste 1;raz:Fornecedor Teste 1;cnpj:01.124.578/0001-51|\u014b|control:F1;id_erp:2;intv:0;fant:ProgenBR;raz:Progen Brasil Tecnologia LTDA;cnpj:37.856.916/0001-58",
        "formato": "txt"
    }
]

Response

201

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação
importados	number	Quantidade de importações realizadas
msg_atencao	string	Mensagem caso ocorra algum erro na importação
conteudo	string	Mensagem sobre o resultado da importação

401

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação
erro	string	Descrição do erro
conteudo	string

Produtos

POST

/produtos Insere ou atualiza os produtos do importador da aplicação recebidos pela array com os produtos no body

Insere ou atualiza os produtos do importador da aplicação recebidos pela array com os produtos no body

None/produtos

Headers

Content-Type	application/json

Body

cnpj *	string	CNPJ de quem está fazendo a importação
formato *	string	Formato do conteúdo recebido
conteudo *	string	Conteúdo a ser enviado para a importação

[
    {
        "cnpj": "12.345.678/9012-34",
        "conteudo": "control:P0|\u00a7|cnpj:12.345.678/9012-34|\u00a7|id_erp:53604|\u00a7|desc:FITA ADESIVA 12X30 QUALIPE ADELBRAS|\u00a7|gtin:7896603803611|\u00a7|cst_liq:1.07|\u00a7|vend:2.99|\u00a7|lcr_liq:179.4|\u00a7|qtd_min:2.00|\u00a7|est:10.00|\u00a7|un:un|\u00a7|pes:N|\u00a7|intv:0|\u00a7|ncm:39191010|\u00a7|atlz:21/10/22|\u00a7|un_emb:un|\u00a7|qtd_emb:10.00|\u00a7|prom:0|\u00a7|id_erp_set:1|\u00a7|desc_set:Uso dom\u00e9stico|\u00a7|id_erp_grp:1|\u00a7|desc_grp:Col\u00e1veis|\u00a7|id_erp_sgrp:1|\u00a7|desc_sgrp:Fitas|\u00a7|id_erp_forn:2",
        "formato": "txt"
    }
]

Response

201

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação
importados	number	Quantidade de importações realizadas
msg_atencao	string	Mensagem caso ocorra algum erro na importação
conteudo	string	Mensagem sobre o resultado da importação

401

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação
erro	string	Descrição do erro
conteudo	string

Venda

POST

/vendas Insere Venda, item venda e cancelamento

Insere Venda, item venda e cancelamento

None/vendas

Headers

Content-Type	application/json

Body

id_venda *	Integer	Identificador da venda
numero_cupom *	Integer	Número do cupom
data_inclusao *	String	Data de inclusão no formato 'YYYY-MM-DDTHH:MM:SS'
status_venda *	String	Status da venda
data_conclusao	String	Data de conclusão no formato 'YYYY-MM-DDTHH:MM:SS'
data_cancelamento	String	Data de cancelamento no formato 'YYYY-MM-DDTHH:MM:SS' ou null
total_liquido	Integer	Total líquido da venda ou null
total_bruto	Integer	Total bruto da venda ou null
desconto_total	Integer	Desconto total da venda ou null
acrescimo_total	Integer	Acréscimo total da venda ou null
id_operador *	Integer	Identificador do operador
id_cliente	Integer	Identificador do cliente ou null
id_usuario_conclusao *	Integer	Identificador do usuário de conclusão
data_pagamento *	String	Data de pagamento no formato 'YYYY-MM-DDTHH:MM:SS'
id_usuario_pagamento *	Integer	Identificador do usuário de pagamento
id_usuario_cancelamento *	Integer	Identificador do usuário de cancelamento
id_motivo_canc	Integer	Identificador do motivo de cancelamento ou null
itens *	Array	Array de itens da venda
ao_consumidor *	Boolean	Flag indicando se a venda é ao consumidor
id_externo_pdv *	Integer	Identificador externo do PDV

{
    "acrescimo_total": null,
    "ao_consumidor": true,
    "data_cancelamento": null,
    "data_conclusao": "2023-12-07T10:08:50.565662",
    "data_inclusao": "2023-12-07T10:08:17",
    "data_pagamento": "2023-12-07T10:08:49.043360",
    "desconto_total": null,
    "id_cliente": null,
    "id_externo_pdv": 1,
    "id_motivo_canc": null,
    "id_operador": 8,
    "id_usuario_cancelamento": 8,
    "id_usuario_conclusao": 8,
    "id_usuario_pagamento": 8,
    "id_venda": 219,
    "itens": [
        {
            "acrescimo": null,
            "cancelado": false,
            "data_canc": null,
            "data_inclusao": "2023-12-07T10:08:17.843054",
            "desconto": null,
            "id_item_venda": 60,
            "id_produto": "216464",
            "id_produto_embalagem": 2,
            "id_usuario_canc": null,
            "id_venda": 219,
            "num_item": 1,
            "preco_venda": "4.8900",
            "quantidade": "1.0000",
            "total": "4.8900"
        },
        {
            "acrescimo": null,
            "cancelado": false,
            "data_canc": null,
            "data_inclusao": "2023-12-07T10:08:17.843054",
            "desconto": null,
            "id_item_venda": 62,
            "id_produto": "318995",
            "id_produto_embalagem": 235,
            "id_usuario_canc": null,
            "id_venda": 219,
            "num_item": 2,
            "preco_venda": "3.8900",
            "quantidade": "1.0000",
            "total": "3.8900"
        },
        {
            "acrescimo": null,
            "cancelado": false,
            "data_canc": null,
            "data_inclusao": "2023-12-07T10:08:17.843054",
            "desconto": null,
            "id_item_venda": 61,
            "id_produto": "213159",
            "id_produto_embalagem": 11,
            "id_usuario_canc": null,
            "id_venda": 219,
            "num_item": 3,
            "preco_venda": "35.9000",
            "quantidade": "1.0000",
            "total": "35.9000"
        }
    ],
    "numero_cupom": 219,
    "status_venda": "concluida",
    "total_bruto": null,
    "total_liquido": null
}

Response

201

Campo	Tipo de dado	Descrição
resultado	boolean	Resultado da importação

500

Campo	Tipo de dado	Descrição
message	string	Menssagem caso erro da importação