Documentação da APIv1

Request Token

Token

Esse POST gera o token necessário para autenticação das chamadas na API

    curl --location --request POST 'http://compumate.com.br:8811/token' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'username=999' \
    --data-urlencode 'password=64134651243651243654' \
    --data-urlencode 'grant_type=password'

Request Status

Status

Esse GET é apenas para teste de funcionalidade da API


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/status' \    
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request ProdutoTexto

ProdutoTexto/list

Esse GET retorna os textos, cadastrados, de um produto


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtotexto/list?produto=[CODIGO_PRODUTO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

ProdutoTexto/get

Esse GET retorna os textos, cadastrados, de um produto e tipo de texto


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtotexto/get?produto=[CODIGO_PRODUTO]&tipoTexto=[TIPO_TEXTO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request ProdutoGrupo

ProdutoGrupo/list

Esse GET retorna os grupos, cadastrados


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtogrupo/list' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

ProdutoGrupo/list

Esse GET retorna os grupos, cadastrados

O parâmetro web=1 são apenas os grupos configurados para aparecerem na internet

O parâmetro web=0 são os grupos configurados para NÃO aparecerem na internet


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtogrupo/list?web=[0_ou_1]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

ProdutoGrupo/list

Esse GET retorna o grupo


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtogrupo/get?codigo=[CODIGO_GRUPO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

ProdutoGrupo/list

Esse GET retorna o grupo


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtogrupo/get_bynivel?nivel=[STRING_CODIGO_NIVEL]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request Produto

Produto/List

Esse GET retorna os produtos, cadastrados


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produto/list' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Produto/List

Esse GET retorna os produtos, cadastrados

Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757

Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46

Parâmetro data deve ser no formato YYYY-MM-DD ex: 2021-01-29

Parâmetro datainicial é opcional


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produto/list?datainicial=[DATA]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Produto/List

Esse GET retorna os produtos, cadastrados

Parâmetro ativo deve ser True ou False


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produto/list?ativo=[TRUE_OU_FALSE]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Produto/List

Esse GET retorna os produtos, cadastrados

Parâmetro ativo deve ser True ou False

Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757

Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46

Parâmetro data deve ser no formato YYYY-MM-DD ex: 2021-01-29

Parâmetro datainicial é opcional


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produto/list?ativo=[TRUE_OU_FALSE]&datainicial=[DATA]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Produto/Get

Esse GET retorna o produto, cadastrado

Parâmetro código deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produto/get?codigo=[CODIGO_PRODUTO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Produto/Verify

Esse GET retorna o produto, cadastrado, e todo o estatus do produto. Pode ser usado para validação antes do pedido.

Parâmetro código deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produto/verify?codigo=[CODIGO_PRODUTO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request Produto Arquivo

ProdutoArquivo/List

Esse GET retorna os arquivos dos produtos, cadastrados

Parâmetro código do produto deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtoarquivo/list?codigo=[CODIGO_PRODUTO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

ProdutoArquivo/List

Esse GET retorna os arquivos dos produtos, cadastrados

Parâmetro código do produto deve ser numérico

Parâmetro código do tipo deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtoarquivo/list?codigo=[CODIGO_PRODUTO]&tipo=[CODIGO_TIPO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

ProdutoEstoquePreco/List

Esse GET retorna os estoques e preços dos produtos, cadastrados

Parâmetro produtos deve ser numérico

Parâmetro produtos pode ser uma lista numérica

Parâmetro datainicial deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757

Parâmetro datainicial deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46

Parâmetro datainicial deve ser no formato YYYY-MM-DD ex: 2021-01-29

Parâmetro datainicial é opcional

Parâmetro produtos é opcional


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/produtoarquivo/list?produtos=[CODIGO_PRODUTO_OU_LISTA]&datainicial=[DATA]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request Pedido

Pedido/Get

Esse GET retorna um pedido inserido no sistema.

Parâmetro controle deve ser numérico. Representa a chave do pedido


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/get?controle=[CONTROLE]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

    {
    "statusCode": 200,
    "message": "Pedido Encontrado",
    "content": [
        {
            "controle": 1111111111111,
            "cliente": {
                "codigo": 75899,
                "nome": "MARIA JOSE DA SILVA",
                "razaoSocial": "MARIA JOSE DA SILVA",
                "documento": "111.111.111-11",
                "documentoTipo": "CPF",
                "rg": "",
                "ie": "ISENTO",
                "im": "",
                "suframa": "",
                "dataNascimento": "1900-01-01T00:00:00",
                "sexo": "",
                "telefones": null,
                "email": "maria2000006421674006@testeteste.com",
                "endereco": {
                    "codigo": 0,
                    "nome": "Principal",
                    "endereco": "RUA PRINCIPAL DA CIDADE",
                    "complemento": "CASA",
                    "numero": "100",
                    "cidade": "VISCONDE DO RIO BRANCO",
                    "uf": "MG",
                    "cep": "36520-000",
                    "bairro": "CENTRO",
                    "pais": ""
                }
            },
            "data": "2023-09-12T00:00:00",
            "dataEmissao": "2023-09-12T10:54:56",
            "emissor": {
                "codigo": 1,
                "nome": "COMPUMATE SOFTWARES CORPORATIVOS LTDA",
                "razaoSocial": "COMPUMATE SOFTWARES CORPORATIVOS LTDA",
                "documento": "92.343.375/0001-72",
                "ie": "1111111111",
                "im": "",
                "dataFundacao": null,
                "dataCadastro": "2014-07-01T00:00:00",
                "dataAlt": "2025-03-11T11:17:03.56",
                "gerente": "",
                "endereco": {
                    "nome": "Principal",
                    "endereco": "RUA NENHUM",
                    "complemento": "",
                    "numero": "1000",
                    "cidade": "VENANCIO AIRES",
                    "uf": "RS",
                    "cep": "95800-000",
                    "bairro": "CENTRO",
                    "pais": "BRASIL"
                },
                "telefone": "(51) 3793-3500",
                "fax": "",
                "email": "richard@compumate.com.br",
                "homepage": ""
            },
            "nota": 97024,
            "serie": "1",
            "modeloNFE": 55,
            "modeloNFEDescricao": "NF-e",
            "cfop": "6108",
            "pedido": 89208,
            "pedidoCliente": "111111111",
            "pedidoCliente2": "xklm213213213",
            "statusPedido": 2,
            "statusPedidoData": "2023-09-12T10:54:54",
            "clienteObservacao":"Teste Observação",
            "nfeChave": "64564456456456456465645465456465",
            "valorNota": 619.8,
            "valorOutras": 0,
            "valorFrete": 0,
            "valorSeguro": 0,
            "valorServicos": 0,
            "valorFunrural": 0,
            "valorDesconto": 0,
            "valorAcrescimo": 0,
            "liberado": true,
            "condicaoPagamento": {
                "codigo": 18,
                "nome": "MERCADO LIVRE",
                "parcelas": 1
            },
            "transportador": {
                "codigo": 0,
                "nome": "",
                "documento": "",
                "rastreio": "97024",
                "rastreioLink": ""
            },
            "enderecoCobranca": {
                "codigo": 106900,
                "nome": "MARIA JOSE DA SILVA",
                "endereco": "RUA PRINCIPAL DA CIDADE",
                "complemento": "CASA",
                "numero": "100",
                "cidade": "VISCONDE DO RIO BRANCO",
                "uf": "MG",
                "cep": "36520-000",
                "bairro": "CENTRO",
                "pais": "BRASIL"
            },
            "enderecoEntrega": {
                "codigo": 106900,
                "nome": "MARIA JOSE DA SILVA",
                "endereco": "RUA PRINCIPAL DA CIDADE",
                "complemento": "CASA",
                "numero": "100",
                "cidade": "VISCONDE DO RIO BRANCO",
                "uf": "MG",
                "cep": "36520-000",
                "bairro": "CENTRO",
                "pais": "BRASIL"
            },
            "statusPedidoHistorico": [
                {
                    "codigo": 19,
                    "automatico": 0,
                    "obs": "",
                    "nome": "ANYMARKET",
                    "dataalt": "2023-09-08T09:00:39"
                },
                {
                    "codigo": 30,
                    "automatico": 0,
                    "obs": "Alteração em Lote",
                    "nome": "AGUARDANDO EMISSÃO",
                    "dataalt": "2023-09-08T10:11:12"
                },
                {
                    "codigo": 2,
                    "automatico": 0,
                    "obs": "",
                    "nome": "FATURADO",
                    "dataalt": "2023-09-12T10:54:54"
                }
            ],
            "produtos": [
                {
                    "produto": 679,
                    "descricao": "300E - Aplique Muller Canga Envelhecido 300E",
                    "quantidade": 3,
                    "valorUnitario": 206.6,
                    "valorTotal": 619.8,
                    "valorDesconto": 0,
                    "item": 0
                }
            ]
        }
    ],
    "techInfo": null
}
    

Request Pedido Cliente

Pedido Cliente/Get

Esse GET retorna a lista de pedidos inseridos no sistema que possuem esse identificador de "PedidoCliente".

Parâmetro PedidoCliente deve ser alfanumérico. Representa a chave/id do pedido no sistema cliente.


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getPedidoCliente?pedidoCliente=[IDENTIFICADOR]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

    {
    "statusCode": 200,
    "message": "Pedido Encontrado",
    "content": [
        {
            "controle": 1111111111111,
            "cliente": {
                "codigo": 75899,
                "nome": "MARIA JOSE DA SILVA",
                "razaoSocial": "MARIA JOSE DA SILVA",
                "documento": "111.111.111-11",
                "documentoTipo": "CPF",
                "rg": "",
                "ie": "ISENTO",
                "im": "",
                "suframa": "",
                "dataNascimento": "1900-01-01T00:00:00",
                "sexo": "",
                "telefones": null,
                "email": "maria2000006421674006@testeteste.com",
                "endereco": {
                    "codigo": 0,
                    "nome": "Principal",
                    "endereco": "RUA PRINCIPAL DA CIDADE",
                    "complemento": "CASA",
                    "numero": "100",
                    "cidade": "VISCONDE DO RIO BRANCO",
                    "uf": "MG",
                    "cep": "36520-000",
                    "bairro": "CENTRO",
                    "pais": ""
                }
            },
            "data": "2023-09-12T00:00:00",
            "dataEmissao": "2023-09-12T10:54:56",
            "emissor": {
                "codigo": 1,
                "nome": "COMPUMATE SOFTWARES CORPORATIVOS LTDA",
                "razaoSocial": "COMPUMATE SOFTWARES CORPORATIVOS LTDA",
                "documento": "92.343.375/0001-72",
                "ie": "1111111111",
                "im": "",
                "dataFundacao": null,
                "dataCadastro": "2014-07-01T00:00:00",
                "dataAlt": "2025-03-11T11:17:03.56",
                "gerente": "",
                "endereco": {
                    "nome": "Principal",
                    "endereco": "RUA NENHUM",
                    "complemento": "",
                    "numero": "1000",
                    "cidade": "VENANCIO AIRES",
                    "uf": "RS",
                    "cep": "95800-000",
                    "bairro": "CENTRO",
                    "pais": "BRASIL"
                },
                "telefone": "(51) 3793-3500",
                "fax": "",
                "email": "richard@compumate.com.br",
                "homepage": ""
            },
            "nota": 97024,
            "serie": "1",
            "modeloNFE": 55,
            "modeloNFEDescricao": "NF-e",
            "cfop": "6108",
            "pedido": 89208,
            "pedidoCliente": "111111111",
            "pedidoCliente2": "xklm213213213",
            "statusPedido": 2,
            "statusPedidoData": "2023-09-12T10:54:54",
            "clienteObservacao":"Teste Observação",
            "nfeChave": "64564456456456456465645465456465",
            "valorNota": 619.8,
            "valorOutras": 0,
            "valorFrete": 0,
            "valorSeguro": 0,
            "valorServicos": 0,
            "valorFunrural": 0,
            "valorDesconto": 0,
            "valorAcrescimo": 0,
            "liberado": true,
            "condicaoPagamento": {
                "codigo": 18,
                "nome": "MERCADO LIVRE",
                "parcelas": 1
            },
            "transportador": {
                "codigo": 0,
                "nome": "",
                "documento": "",
                "rastreio": "97024",
                "rastreioLink": ""
            },
            "enderecoCobranca": {
                "codigo": 106900,
                "nome": "MARIA JOSE DA SILVA",
                "endereco": "RUA PRINCIPAL DA CIDADE",
                "complemento": "CASA",
                "numero": "100",
                "cidade": "VISCONDE DO RIO BRANCO",
                "uf": "MG",
                "cep": "36520-000",
                "bairro": "CENTRO",
                "pais": "BRASIL"
            },
            "enderecoEntrega": {
                "codigo": 106900,
                "nome": "MARIA JOSE DA SILVA",
                "endereco": "RUA PRINCIPAL DA CIDADE",
                "complemento": "CASA",
                "numero": "100",
                "cidade": "VISCONDE DO RIO BRANCO",
                "uf": "MG",
                "cep": "36520-000",
                "bairro": "CENTRO",
                "pais": "BRASIL"
            },
            "statusPedidoHistorico": [
                {
                    "codigo": 19,
                    "automatico": 0,
                    "obs": "",
                    "nome": "ANYMARKET",
                    "dataalt": "2023-09-08T09:00:39"
                },
                {
                    "codigo": 30,
                    "automatico": 0,
                    "obs": "Alteração em Lote",
                    "nome": "AGUARDANDO EMISSÃO",
                    "dataalt": "2023-09-08T10:11:12"
                },
                {
                    "codigo": 2,
                    "automatico": 0,
                    "obs": "",
                    "nome": "FATURADO",
                    "dataalt": "2023-09-12T10:54:54"
                }
            ],
            "produtos": [
                {
                    "produto": 679,
                    "descricao": "300E - Aplique Muller Canga Envelhecido 300E",
                    "quantidade": 3,
                    "valorUnitario": 206.6,
                    "valorTotal": 619.8,
                    "valorDesconto": 0,
                    "item": 0
                }
            ]
        }
    ],
    "techInfo": null
}
    

Request Lista Pedido

Lista Pedido/Get

Esse GET retorna a lista de pedidos inseridos no sistema emitidos por um CNPJ para uma documento de cliente (CPF/CNPJ).

Parâmetro emissorDocumento documento do emissor, preferencialmente sem formatação.

Parâmetro clienteDocumento documento do cliente, preferencialmente sem formatação.

Parâmetro dataInicial data no formato abaixo. Exemplo (2024-12-01).

Parâmetro dataFinal documento do formato abaixo. Exemplo (2024-12-01).

Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757

Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46

Parâmetro data deve ser no formato YYYY-MM-DD ex: 2021-01-29

Parâmetro datainicial é opcional


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getListaPedido?emissorDocumento=[EMISSOR_DOCUMENTO]&clienteDocumento=[CLIENTE_DOCUMENTO]&' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Incluir Pedido

Pedido/Post

Esse POST cadastra um pedido no sistema.


    curl --location --request POST 'http://compumate.com.br:8811/apiv1/pedido/add' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Exemplo de Post para inclusão de Pedido

Atributo Pedido.Pedido você deve ir incrementando para a inclusão de novos pedidos

Atributo Pedido.Cliente será cadastrado no sistema, caso não existir, automaticamente. O campo chave é o documento.

Atributo Pedido.enderecoEntrega não é obrigatório, mas é recomendado. Esse endereço é para onde o produto / encomenda / nota deverá ser enviado.

Atributo Pedido.enderecoCobranca não é obrigatório, mas é recomendado. Esse endereço é para onde os dados e documento de faturamento ee ou cobrança deverão ser enviados.

Caso nenhum endereço for preenchido, será usado o Pedido.Cliente.Endereco. Caso esse usuário faça 2 pedidos com endereços diferentes e caso os pedidos sejam faturados no mesmo momento, ambos os pedidos serão validados com o endereço do último pedido adicionado.


    {
	"cliente":{
		"nome":"Fulano de Tal",
		"documento":"90584903006",
		"documentoTipo":"CPF",
		"rg":"259334868",
		"ie":"",
		"im":"",
		"suframa":"",
		"dataNascimento":"1981-01-01",
		"sexo":"",
		"telefones":
		[
			{
				"contato":"Zé Fulano",
				"telefone":"51999998877",
				"movel":true
			},
			{
				"contato":"Zé Fulano",
				"telefone":"5137939999",
				"movel":false
			}
		],
		"email":"fulano@email.com.br",
		"endereco":{
			"nome":"Casa",
			"endereco":"Jacob Becker",
			"complemento":"Casa",
			"numero":"1824",
			"cidade":"Venâncio Aires",
			"uf":"RS",
			"cep":"95800-000",
			"bairro":"Centro",
			"pais":"Brasil"
		}
	},
	"clienteObservacao":"Teste Observação",
	"enderecoEntrega":{
		"nome":"Empresa",
		"endereco":"Rua Emílio Selbach",
		"complemento":"compumate",
		"numero":"825",
		"cidade":"Venâncio Aires",
		"uf":"RS",
		"cep":"95800-000",
		"bairro":"Centro",
		"pais":"Brasil"
	},
	"enderecoCobranca":{
		"nome":"Casa",
		"endereco":"Jacob Becker",
		"complemento":"Casa",
		"numero":"1824",
		"cidade":"Venâncio Aires",
		"uf":"RS",
		"cep":"95800-000",
		"bairro":"Centro",
		"pais":"Brasil"
	},
	"pedido":"TESTE-001",
	"dataCriacao":"2021-03-01T01:00:01.123",
	"dataModificacao":"2021-03-01T01:00:01.123",
	"formaPagamento":{
		"descricao":"BOLETO",
		"parcelas":1,
		"idTransacao":"ID-8123782178397821973",
		"data":"2021-03-01T01:00:01.123",
		"obs":"observação no boleto - não imprime"
	}
	"cupom":"cupom5";
	"valorDesconto":.0,
	"valorAcrescimo":.0,
	"valorFrete":350.00,
	"valorTotal":5000.59,
	"itens":[
		{
			"codigo":22,
			"descricao":"EXPOSITORA DE BEBIDAS VVCD 200L AMARELA 127 V",
			"quantidade":1.0,
			"unitario":2949.0,
			"total":2899.0,
			"desconto":50.0			
		}
	],
    "transportador": {
        "nome": "Correio PAC",
        "prazo": "18\/03\/2024 00:00:00",
        "obs": null,
        "rastreio": "12345",
        "rastreioLink":"http://"
    }
}

Atributo Pedido.filial não é obrigatório. Quando não utilizado, o sistema irá usar por padrão a filial configurado no sistema para inclusão de pedidos.


    {
    "filial":1,
	"cliente":{
		"nome":"Fulano de Tal",
		"documento":"90584903006",
		"documentoTipo":"CPF",
		"rg":"259334868",
		...
    ...
    }
}

Request do XML Nfe

Pedido/getXML

Esse GET retorna o arquivo XML da nota fiscal referente ao pedido, caso tenha sido emitida

Parâmetro controle do pedido deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getXML?controle=[CONTROLE_PEDIDO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Pedido/getXMLLink

Esse GET retorna um objeto json que contém o link do arquivo XML da nota fiscal referente ao pedido, caso tenha sido emitida

Parâmetro controle do pedido deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getXMLLink?controle=[CONTROLE_PEDIDO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request do PDF Nfe

Pedido/getPDF

Esse GET retorna o arquivo PDF da nota fiscal referente ao pedido, caso tenha sido emitida

Parâmetro controle do pedido deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getPDF?controle=[CONTROLE_PEDIDO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Pedido/getPDFLink

Esse GET retorna um objeto json que contém o link do arquivo PDF da nota fiscal referente ao pedido, caso tenha sido emitida

Parâmetro controle do pedido deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getPDFLink?controle=[CONTROLE_PEDIDO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Request do PDF Boleto

Pedido/getBoleto

Esse GET retorna o arquivo PDF do boleto referente ao pedido, caso tenha sido emitido

Parâmetro controle do pedido deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getBoleto?controle=[CONTROLE_PEDIDO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Pedido/getBoletoLink

Esse GET retorna um objeto json que contém o link do arquivo PDF do boleto referente ao pedido, caso tenha sido emitido

Parâmetro controle do pedido deve ser numérico


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedido/getBoletoLink?controle=[CONTROLE_PEDIDO]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Status Pedido

PedidoStatus/Cancelar

Esse POST cancela (remove) um pedido caso ele ainda não tenha sido liberado ou troca o status do pedido para cancelado (dependendo das configurações) caso ele já tenha sido liberaod.

Parâmetro controle do pedido deve ser numérico

Parâmetro observacao do status (Opcional)


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/pedidostatus/cancelar?controle=[CONTROLE_PEDIDO]&observacao=[TEXTO_OBSERVAÇÃO_OPCIONAL]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Consultar Cliente(s)

Cliente/Get?codigo=XXXX

Esse GET retorna os dados de um cliente/forncedor.

Parâmetro codigo do cliente/fornecedor, preferencialmente sem formatação.


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/cliente/get?codigo=[CODIGO_DO_CLIENTE]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'

Exemplo de Get para consulta de cliente fornecedor


    {
        "statusCode": 200,
        "message": "OK",
        "content": {
            "codigo": 999,
            "razaoSocial": "RAZAO SOCIAL LTDA",
            "nome": "NOME FANTASIA",
            "documento": "99.999.999/0001-99",
            "rg": "",
            "ie": "509999999999",
            "im": "",
            "observacoes": "OBSERVAÇÕES DO CADATROS",
            "email": [
                {
                    "email": "emaildaempresa@empresa.com",
                    "contato": "",
                    "tipo": "Comercial"
                },
                {
                    "email": "emaildaempresa@empresa.com",
                    "contato": "",
                    "tipo": "Compras"
                },
                {
                    "email": "emaildaempresa@empresa.com",
                    "contato": "",
                    "tipo": "CT-e"
                },
                {
                    "email": "emaildaempresa@empresa.com",
                    "contato": "",
                    "tipo": "Financeiro"
                },
                {
                    "email": "emaildaempresa@empresa.com",
                    "contato": "",
                    "tipo": "NF-e"
                },
                {
                    "email": "emaildaempresa@empresa.com",
                    "contato": "",
                    "tipo": "Outros"
                }
            ],
            "fone": [
                {
                    "ddi": "51",
                    "ddd": "+55",
                    "fone": "3793-3500",
                    "contato": "",
                    "tipo": "Comercial"
                },
                {
                    "ddi": "51",
                    "ddd": "+55",
                    "fone": "3793-3500",
                    "contato": "",
                    "tipo": "CT-e"
                },
                {
                    "ddi": "51",
                    "ddd": "+55",
                    "fone": "3793-3500",
                    "contato": "",
                    "tipo": "Financeiro"
                },
                {
                    "ddi": "51",
                    "ddd": "+55",
                    "fone": "3793-3500",
                    "contato": "",
                    "tipo": "NF-e"
                },
                {
                    "ddi": "51",
                    "ddd": "+55",
                    "fone": "3793-3500",
                    "contato": "",
                    "tipo": "WhatsApp"
                }
            ],
            "endereco": {
                "nome": "NOME FANTASIA",
                "endereco": "RUA RUA RUA RUA RUA",
                "complemento": "CASA REFERENCIA: ATRÁS DO CEMITÉRIO",
                "numero": "10",
                "cidade": "VENANCIO AIRES",
                "uf": "RS",
                "cep": "95800-000",
                "bairro": "CENTRO",
                "pais": "BRASIL",
                "homepage": "",
                "longitude": 0.0,
                "latitude": 0.0,
                "dataalt": "2024-10-10T19:28:37.287"
            },
            "enderecoEntrega": {
                "codigo": 4000,
                "entrega": true,
                "cobranca": false,
                "redespacho": false,
                "fone": "",
                "email": "",
                "observacoes": "",
                "nome": "NOME FANTASIA",
                "endereco": "RUA RUA RUA RUA RUA",
                "complemento": "CASA REFERENCIA: ATRÁS DO CEMITÉRIO",
                "numero": "10",
                "cidade": "VENANCIO AIRES",
                "uf": "RS",
                "cep": "95800-000",
                "bairro": "CENTRO",
                "pais": "BRASIL",
                "homepage": "",
                "longitude": 0.0,
                "latitude": 0.0,
                "dataalt": "2024-08-03T07:20:49.4"
            },
            "enderecoCobranca": {
                "codigo": 3982,
                "entrega": true,
                "cobranca": false,
                "redespacho": false,
                "fone": "",
                "email": "",
                "observacoes": "",
                "nome": "NOME FANTASIA",
                "endereco": "RUA RUA RUA RUA RUA",
                "complemento": "CASA REFERENCIA: ATRÁS DO CEMITÉRIO",
                "numero": "10",
                "cidade": "VENANCIO AIRES",
                "uf": "RS",
                "cep": "95800-000",
                "bairro": "CENTRO",
                "pais": "BRASIL",
                "homepage": "",
                "longitude": 0.0,
                "latitude": 0.0,
                "dataalt": "2024-08-03T07:20:49.4"
            },
            "enderecoRedespacho": null,
            "dataNascimento": "0001-01-01T00:00:00",
            "dataCadastro": "2024-08-03T00:00:00",
            "dataRevisaoCadastro": "2024-08-05T00:00:00",
            "ativo": true
        },
        "techInfo": null
    }

Cliente/GetDocumento?documento=XXXXXXXXXXX

Esse GET retorna uma array com os dados de clientes/forncedores que possuem este documento.

Parâmetro documento do cliente/fornecedor, CPF CNPJ, preferencialmente sem formatação.


    curl --location --request GET 'http://compumate.com.br:8811/apiv1/cliente/getdocumento?documento=[DOCUMENTO_DO_CLIENTE]' \
    --header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'


    {
        "statusCode": 200,
        "message": "OK",
        "content": [{
            "codigo": 999,
            "razaoSocial": "RAZAO SOCIAL LTDA",
            "nome": "NOME FANTASIA",
            "documento": "99.999.999/0001-99",
            "rg": "",
            "ie": "509999999999",
            "im": "",
            .......
        },
        {
            "codigo": 1000,
            "razaoSocial": "RAZAO SOCIAL LTDA",
            "nome": "NOME FANTASIA",
            "documento": "99.999.999/0001-99",
            "rg": "",
            "ie": "509999999999",
            "im": "",
            .......
        }],
        "techInfo": null
    }