Endpoints Agrupados - API Commons

Última atualização: 4 meses atrás Tempo de leitura: 35 minutos

ferramentas API APIRest Basico Web Desktop

O que é?

A API Commons consiste em endpoints de consulta aos cadastros do sistema. Não há processamento ou tratamento das informações retornadas. Cada endpoint corresponde diretamente a uma tabela do banco de dados.

Como Funciona no Uniplus?

1. Endpoint Administradoras de cartão (v1)

Administradoras de cartão

URL: “/public-api/v1/commons/administradoracartao“
Verbos suportados: GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "cnpj":"Texto", "rede":"Texto", "estabelecimento":"Texto", "credenciadoracfe":0, "permitetaxazero":0, "inativo":0, "carteiradigital":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/administradoracartao

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/administradoracartao/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código de cadastro da administradora		Caractere	14
nome	Nome da administradora		Caractere	50
cnpj	CNPJ da administradora		Caractere	18
rede	Código da rede		Caractere	20
estabelecimento	Código do estabelecimento		Caractere	20
credenciadoracfe	Credenciadora para o CF-e
permitetaxazero	Permite cadastrar taxa zero
inativo	Identifica se a administradora de cartão está inativa
carteiradigital	Carteira digital					0 – Não 1 – Sim

2. Endpoint Ajuste do documento fiscal (v1)

Ajuste do documento fiscal

URL: “/public-api/v1/commons/ajustedocumentofiscal“
Verbos suportados: GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "calcularcustopreco":0, "tipocalculoajustedocfiscal":"Texto"}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
calcularcustopreco	Consumidor final		Inteiro			0 – Não 1 – Sim
tipocalculoajustedocfiscal	Tipo de cálculo do ajuste de documento fiscal		Caractere	5		D – Débito C – Crédito

3. Endpoint Alíquotas por estado (v1)

Alíquotas por estado

URL: “/public-api/v1/commons/aliquotaestado“
Verbos suportados: GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "tipoaliquota":0, "idestado":1, "aliquota":"0.00"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/aliquotaestado

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/aliquotaestado/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
tipoaliquota	Tipo da alíquota		Inteiro			0 – ICMS
idestado	Estado		Inteiro
aliquota	Alíquota		Decimal	5

4. Endpoint Apurações de ICMS (v1)

Apurações de ICMS

URL: “/public-api/v1/commons/ajusteapuracaoicms“
Verbos suportados: GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/ajusteapuracaoicms

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código ajustes da apuração do ICMS		Caractere	8
descricao	Descrição do código		Caractere	100

5. Endpoint Apurações de impostos (v1)

Apurações de impostos

URL: “/public-api/v1/commons/apuracaoimposto“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "anomes":"yyyy-MM-dd"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/apuracaoimposto

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
anomes	Ano e mês da apuração

6. Endpoint Bancos (v1)

Bancos

URL: “/public-api/v1/commons/banco“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/banco

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/banco/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código FEBRABAN do banco		Caractere	6
nome	Nome do banco		Caractere	60

7. Endpoint Bandeiras de cartão (v1)

Bandeiras de cartão

URL: “/public-api/v1/commons/bandeiracartao“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "nome":"Texto", "codigo":"Texto", "codigobandeira":"Texto", "tipobandeira":"Texto", "inativo":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/bandeiracartao

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/bandeiracartao/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
nome	Nome da bandeira		Caractere	50
codigo	Código de cadastro		Caractere	20
codigobandeira	Código da bandeira		Caractere	20
tipobandeira	Tipo de bandeira		Caractere	2		01 – Visa; 02 – Mastercard; 03 – American Express; 04 – Sorocred; 05 – Diners Club; 06 – Elo; 07 – Hipercard; 08 – Aura; 09 – Cabal; 10 – Alelo; 11 – Banes Card; 12 – CalCard; 13 – Credz; 14 – Discover; 15 – GoodCard; 16 – GreenCard; 17 – Hiper; 18 – JcB; 19 – MaisB; 20 – MaxVan; 21 – Policard; 22 – RedeCompras; 23 – Sodexo; 24 – ValeCard; 25 – Verocheque; 26 – VR; 27 – Ticket; 99 – Outro.
inativo	Identifica se a bandeira está inativa		Inteiro

8. Endpoint Benefícios fiscais (v1)

Benefícios fiscais

URL: “/public-api/v1/commons/beneficiofiscal“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "cst00":0, "cst10":0, "cst20":0, "cst30":0, "cst40":0, "cst41":0, "cst50":0, "cst51":0, "cst60":0, "cst61":0, "cst70":0, "cst90":0, "idestado":1, "codigoestado":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/beneficiofiscal

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/beneficiofiscal/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	10
descricao	Descrição		Caractere	512
cst00	CST 00		Inteiro			0 – Não; 1 – Sim.
cst10	CST 10		Inteiro			0 – Não; 1 – Sim.
cst20	CST 20		Inteiro			0 – Não; 1 – Sim.
cst30	CST 30		Inteiro			0 – Não; 1 – Sim.
cst40	CST 40		Inteiro			0 – Não; 1 – Sim.
cst41	CST 41		Inteiro			0 – Não; 1 – Sim.
cst50	CST 50		Inteiro			0 – Não; 1 – Sim.
cst51	CST 51		Inteiro			0 – Não; 1 – Sim.
cst60	CST 60		Inteiro			0 – Não; 1 – Sim.
cst61	CST 61		Inteiro			0 – Não; 1 – Sim.
cst70	CST 70		Inteiro			0 – Não; 1 – Sim.
cst90	CST 90		Inteiro			0 – Não; 1 – Sim.
idestado	ID do estado		Inteiro
codigoestado	UF		Caractere	2

9. Endpoint Categorias de clientes (v1)

Categorias de clientes

URL: “/public-api/v1/commons/categoriacliente“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/categoriacliente

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/categoriacliente/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
descricao	Descrição		Caracter	50

10. Endpoint Categorias do e-commerce (v1)

Categorias do e-commerce

URL: “/public-api/v1/commons/gruposhop“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "nome":"Texto", "ordem":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/gruposhop

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/gruposhop/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
nome	Nome		Caractere	40
ordem	Índice de ordenação		Inteiro

11. Endpoint Centros de custo (v1)

Centros de custo

URL: “/public-api/v1/commons/centrocusto“
Verbos suportados: GET

Status HTTP

200 = OK ;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idempresa":1, "descricao":"Texto", "codigoreduzido":"Texto", "codigoextenso":"Texto", "inativa":0, "obrigatorio":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/centrocusto

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/centrocusto/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idempresa	ID da empresa		Inteiro
descricao	Descrição		Caractere	50
codigoreduzido	Código reduzido		Caractere	20
codigoextenso	Código extenso		Caractere	81
inativa	Inativa		Inteiro
obrigatorio	Obrigatório		Inteiro

12. Endpoint CEPs (v1)

CEPs

URL: “/public-api/v1/commons/cep“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "endereco":"Texto", "bairro":"Texto", "cep":"Texto", "idcidade":1, "idmunicipio":1, "realizaentrega":0, "codigotaxaentrega":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cep

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cep/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
endereco	Endereço		Caractere	100
bairro	Bairro		Caractere	100
cep	CEP		Caractere	8
idcidade	ID da cidade		Inteiro
idmunicipio	Código IBGE		Inteiro
realizaentrega	Realiza entrega		Inteiro			0 – Não; 1 – Sim.
codigotaxaentrega	Código da taxa de entrega		Inteiro

13. Endpoint CEST (Segmentos de Mercadorias e Bens) (v1)

CEST (Segmentos de Mercadorias e Bens)

URL: “/public-api/v1/commons/cest“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhe.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "descricaoncm":"Texto", "inativo":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cest

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cest/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	10
descricao	Descrição		Caractere
descricaoncm	Descrição do NCM		Caractere
inativo	Inativo		Inteiro			0 – Não; 1 – Sim.

14. Endpoint Cidades (v1)

Cidades

URL: “/public-api/v1/commons/cidade“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "nome":"Texto", "idestado":1, "codigoibge":0, "codigotom":"Texto", "realizaentrega":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cidade

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cidade/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código de cadastro da cidade		Inteiro
nome	Nome da cidade		Caractere	50
idestado	ID do estado		Inteiro
codigoibge	Código da cidade conforme tabela oficial IBGE		Inteiro
codigotom	Código TOM		Caractere	4
realizaentrega	Realiza entrega		Inteiro			0 – Não; 1 – Sim.

16. Endpoint Condições de pagamento (v1)

Condições de pagamento

URL: “/public-api/v1/commons/condicaopagamento“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "prazos":"Texto", "inativo":0, "prazomedio":0, "tipo":0, "percentual":"0.00", "parcelas":0, "diavencimento":0, "dialimite":0, "escopo":0, "enviamobile":0, "prazomanipulacao":0, "dodispositivo":0, "podeserflex":0, "naoutilizarnopdv":0, "mesescarencia":0, "enviaecommerce":0, "codigomercos":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/condicaopagamento

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	10
descricao	Descrição		Caractere	512
prazos	Prazos em dias da condição		Caractere	512
inativo	Identifica se a condição esta inativa.		Inteiro			0 – Não; 1 – Sim.
prazomedio	Prazo médio da condição de pagamento		Inteiro
tipo	Tipo de condição de pagamento		Inteiro			0 – Acréscimo; 1 – Desconto.
percentual	Percentual de acréscimo ou desconto		Decimal	5	2
parcelas	Número de parcelas		Inteiro
diavencimento	Dia do vencimento		Inteiro
dialimite	Dia limite de venda para o cálculo do primeiro vencimento		Inteiro
escopo	Identifica o escopo de utilização da condição de pagamento. 0 – Compra e venda 1 – Vendas 2 – Compras		Inteiro			0 – Compra e venda; 1 – Vendas; 2 – Compras.
enviamobile	Identifica se esta condição será enviada ao Unimobile Vendas		Inteiro
prazomanipulacao	Prazo permitido ao vendedor de manipulação da condição de pagamento no Unimobile Vendas		Inteiro
dodispositivo	Identifica se esta condição foi incluída no retaguarda(0) ou no dispositivo(1)		Inteiro
podeserflex	Identifica se esta condição pode gerar flex		Inteiro			0 – Não; 1 – Sim.
naoutilizarnopdv	Identifica se a condição de pagamento vai ser utilizada no PDV		Inteiro
mesescarencia	Meses de carência para o primeiro vencimento		Inteiro
enviaecommerce	Indica se a condição de pagamento envia para o e-commece		Inteiro			0-Não; 1-Sim.
codigomercos	Código da condição de pagamento no Mercos		Inteiro

17. Endpoint Contribuição social apurada (v1)

Contribuição social apurada

URL: “/public-api/v1/commons/tipocredito“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipocredito

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipocredito/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	16
descricao	Descrição		Caractere	256

18. Endpoint Créditos de estímulo (v1)

Créditos de estímulo

URL: “/public-api/v1/commons/creditoestimulo“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "descricao":"Texto", "percentual":"0.00", "idajustedocumentofiscal":1, "idajustedocumentofiscalentrada":1, "idajusteapuracaoicms":1, "idobservacaonota":1, "observacaocomplementar":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/creditoestimulo

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
descricao	Descrição		Caractere	100
percentual	Percentual		Decimal	12	2
idajustedocumentofiscal	ID do Ajuste de documento		Inteiro
idajustedocumentofiscalentrada	ID do Ajuste de documento de Entrada		Inteiro
idajusteapuracaoicms	ID do Ajuste da Apuração		Inteiro
idobservacaonota	ID da Observação complementar da nota		Inteiro
observacaocomplementar	ID do Ajuste da Apuração		Caractere	250

19. Endpoint Departamentos (v1)

Departamentos

URL: “/public-api/v1/commons/departamento“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/departamento

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/departamento/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
descricao	Descrição		Caractere	12

20. Endpoint Desmontagem – itens (v1)

Desmontagem – itens

URL: “/public-api/v1/commons/desmontagemitem“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "iddesmontagem":1, "idproduto":1, "idunidademedida":1, "quantidade":"0.000000", "precounitario":"0.000000", "valortotal":"0.00", "percentualperda":"0.000000", "graucusto":"0.000000"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/desmontagemitem

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/desmontagemitem/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
iddesmontagem	ID da desmontagem		Inteiro
idproduto	ID do produto		Inteiro
idunidademedida	ID da unidade de medida		Inteiro
quantidade	Quantidade		Decimal	15	6
precounitario	Preço unitário		Decimal	15	6
valortotal	Valor total		Decimal	12	2
percentualperda	Percentual de perda		Decimal	9	6
graucusto	Grau de custo do produto		Decimal	15	6

21. Endpoint Desmontagem – origens (v1)

Desmontagem – origens

URL: “/public-api/v1/commons/desmontagemorigem“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "iddesmontagem":1, "modelo":"Texto", "iditemorigem":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/desmontagemorigem

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
iddesmontagem	ID da desmontagem		Inteiro
modelo	Modelo de documento de venda		Caractere	6		01 – Nota fiscal; 1 – Nota fiscal; 1-A – Nota fiscal; 1B – Nota fiscal Avulsa; 2 – Nota fiscal; 03 – Nota fiscal de serviços; 3B – Nota fiscal de serviços avulsa; 3A – Nota fiscal de serviços simplificada; 4 – Produtor rural; 6 – Energia elétrica; 7 – Serviço de transporte; 8 – CT rodoviário; 9 – CT aquaviário; 10 – CT aéreo; 11 – CT ferroviário; 13 – Passagem rodoviário; 55 – NF-e; 65 – NFC-e; 59 – SAT; 57 – CT-e; 28 – Gás canalizado; 29 – Agua; 26 – CT Multimodal Cargas; 27 – NFT Ferroviário Carga; 8B – CT Cargas Avulso; 21 – NFS comunicação; 22 – NFS telecomunicação; 66 – NF3e; 67 – CT-e OS; 2D – Cupom ECF,NS-NFS-e; 99 – NFS-e, MEI-Nota Fiscal MEI, MPDV-Cupom MEI, NFAE-NFA-e;
iditemorigem	ID do item do documento		Inteiro

22. Endpoint Desmontagens de produtos (v1)

Desmontagens de produtos

URL: “/public-api/v1/commons/desmontagem“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idfilial":1, "codigo":"Texto", "data":"yyyy-MM-ddTHH:MM:ss", "idproduto":1, "quantidade":"0.000000", "precounitario":"0.000000", "observacao":"Texto", "status":0, "idnotafiscalgerada":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/desmontagem

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/desmontagem/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idfilial	ID da filial		Inteiro
codigo	Código		Caractere	14
data	Data da desmontagem
idproduto	ID do produto		Inteiro
quantidade	Quantidade		Decimal	16	6
precounitario	Preço unitário		Decimal	16	6
observacao	Descrição da desmontagem		Caractere	512
status	Status da desmontagem		Inteiro			0 – Aberto; 1 – Nota fiscal gerada.
idnotafiscalgerada	ID da nota fiscal gerada		Inteiro

24. Endpoint Empresas (v1)

Empresas

URL: “/public-api/v1/commons/empresa“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "razaosocial":"Texto", "tipocontabilizacaosped":0, "numeroordemlivro":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/empresa

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/empresa/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
razaosocial	Razão social		Caractere	50
tipocontabilizacaosped	Tipo da contabilização do sped		Inteiro
numeroordemlivro	Número ordem livro		Caractere	50

25. Endpoint Enquadramento do IPI (v1)

Enquadramento do IPI

URL: “/public-api/v1/commons/enquadramentoipi“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "grupocst":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/enquadramentoipi

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/enquadramentoipi/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	3
grupocst	Grupo de CST		Caractere	20
descricao	Descrição		Caractere

26. Endpoint Estados (v1)

Estados

URL: “/public-api/v1/commons/estado“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "codigoibge":0, "idpais":1, "exigeuffavorecida":0, "exigereceita":0, "exigecontribuinteemitente":0, "exigedatavencimento":0, "exigeconvenio":0, "exigedatapagamento":0, "convenio":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/estado

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/estado/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código do estado		Caractere	2
nome	Nome do estado		Caractere	50
codigoibge	Código do estado conforme tabela oficial IBGE		Inteiro
idpais	Código do país conforme a tabela oficial IBGE		Inteiro
exigeuffavorecida	Identifica se exige UF favorecida na geração da GNRE		Inteiro			0 – Não 1 – Sim
exigereceita	Identifica se exige receita na geração da GNRE		Inteiro			0 – Não 1 – Sim
exigecontribuinteemitente	Identifica se exige contribuinte emitente na geração da GNRE		Inteiro			0 – Não 1 – Sim
exigedatavencimento	Identifica se exige data de vencimento na geração da GNRE		Inteiro			0 – Não 1 – Sim
exigeconvenio	Identifica se exige convênio na geração da GNRE		Inteiro			0 – Não 1 – Sim
exigedatapagamento	Identifica se exige data de pagamento na geração da GNRE		Inteiro			0 – Não 1 – Sim
convenio	Convênio		Caractere	30

27. Endpoint Famílias de produto (v1)

Famílias de produto

URL: “/public-api/v1/commons/familiaproduto“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "nome":"Texto", "qtddiascompra":0, "comissao":"0.00", "comissaoavista":"0.00", "comissaoaprazo":"0.00", "comissaoquitacao":"0.00", "lucrobrutominimo":"0.00", "lucrobrutomaximo":"0.00", "percentualmarkupminimo":"0.00", "percentualmarkupmaximo":"0.00", "percentualmarkdownminimo":"0.00", "percentualmarkdownmaximo":"0.00", "quantidadepauta1":"0.000000", "quantidadepauta2":"0.000000", "quantidadepauta3":"0.000000", "quantidadepauta4":"0.000000"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/familiaproduto

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/familiaproduto/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
nome	Nome		Caractere	40
qtddiascompra	Quantidade de dias para compra		Inteiro
comissao	Percentual de comissão		Decimal	5	2
comissaoavista	Percentual de comissão para vendas à vista		Decimal	5	2
comissaoaprazo	Percentual de comissão para vendas a prazo		Decimal	5	2
comissaoquitacao	Percentual de comissão sobre a quitação		Decimal	5	2
lucrobrutominimo	Lucro mínimo		Decimal	12	2
lucrobrutomaximo	Lucro máximo		Decimal	12	2
percentualmarkupminimo	Percentual markup mínimo		Decimal	12	2
percentualmarkupmaximo	Percentual markup máximo		Decimal	12	2
percentualmarkdownminimo	Percentual markdown mínimo		Decimal	12	2
percentualmarkdownmaximo	Percentual markdown máximo		Decimal	12	2
quantidadepauta1	Quantidade mínima comprada para que o sistema assuma o valor da pauta de preço		Decimal	15	6
quantidadepauta2	Quantidade mínima comprada para que o sistema assuma o valor da pauta de preço		Decimal	15	6
quantidadepauta3	Quantidade mínima comprada para que o sistema assuma o valor da pauta de preço		Decimal	15	6
quantidadepauta4	Quantidade mínima comprada para que o sistema assuma o valor da pauta de preço		Decimal	15	6

28. Endpoint Filiais (v1)

Filiais

URL: “/public-api/v1/commons/filial“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "razaosocial":"Texto", "complemento":"Texto", "numero":"Texto", "bairro":"Texto", "cep":"Texto", "telefone":"Texto", "cnpj":"Texto", "tipopessoa":0, "inscricaoestadual":"Texto", "nsu":0, "cnae":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/filial

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/filial/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caracter	4
razaosocial	Razão social		Caracter	60
complemento	Complemento do endereço		Caracter	50
numero	Número do endereço		Caracter	6
bairro	Bairro		Caracter	50
cep	CEP		Caracter	9
telefone	Telefone		Caracter	17
cnpj	CNPJ		Caracter	18
tipopessoa	Tipo de pessoa		Inteiro			0 – Física; 1 – Jurídica.
inscricaoestadual	Inscrição estadual		Caracter	17
nsu	Número sequencial único		Inteiro
cnae	CNAE		Caracter	7

29. Endpoint Fundo de combate à pobreza (v1)

Fundo de combate à pobreza

URL: “/public-api/v1/commons/fundocombatepobreza“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idestado":1, "idncm":1, "aliquota":"0.00", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/fundocombatepobreza

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/fundocombatepobreza/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idestado	Estado		Inteiro
idncm	NCM		Inteiro
aliquota	Alíquota		Decimal	5	2
descricao	Descrição		Caractere	512

30. Endpoint Grades (v1)

Grades

URL: “/public-api/v1/commons/grade“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "usarimagem":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/grade

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/grade/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	20
descricao	Descrição		Caractere	100
usarimagem	Usa imagem		Inteiro

31. Endpoint Grupos de produtos (v1)

Grupos de produtos

URL: “/public-api/v1/commons/hierarquia“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "nome":"Texto", "comissao":"0.00", "comissaoavista":"0.00", "comissaoaprazo":"0.00", "comissaoquitacao":"0.00"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/hierarquia

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/hierarquia/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
nome	Nome		Caractere	40
comissao	Percentual de comissão		Decimal	5	2
comissaoavista	Percentual de comissão para vendas à vista		Decimal	5	2
comissaoaprazo	Percentual de comissão para vendas a prazo		Decimal	5	2
comissaoquitacao	Percentual de comissão sobre a quitação		Decimal	5	2

32. Endpoint Horários de atendimento (v1)

Horários de atendimento

URL: “/public-api/v1/commons/horarioatendimento“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "horainicialdomingo":"HH:MM:ss", "horafinaldomingo":"HH:MM:ss", "horainicialsegunda":"HH:MM:ss", "horafinalsegunda":"HH:MM:ss", "horainicialterca":"HH:MM:ss", "horafinalterca":"HH:MM:ss", "horainicialquarta":"HH:MM:ss", "horafinalquarta":"HH:MM:ss", "horainicialquinta":"HH:MM:ss", "horafinalquinta":"HH:MM:ss", "horainicialsexta":"HH:MM:ss", "horafinalsexta":"HH:MM:ss", "horainicialsabado":"HH:MM:ss", "horafinalsabado":"HH:MM:ss"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/horarioatendimento

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/horarioatendimento/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
horainicialdomingo	Hora inicial no domingo
horafinaldomingo	Hora final no doming
horainicialsegunda	Hora inicial na segunda
horafinalsegunda	Hora final na segunda
horainicialterca	Hora inicial na terça
horafinalterca	Hora final na terça
horainicialquarta	Hora inicial na quarta
horafinalquarta	Hora final na quarta
horainicialquinta	Hora inicial na quinta
horafinalquinta	Hora final na quinta
horainicialsexta	Hora inicial na sexta
horafinalsexta	Hora final na sexta
horainicialsabado	Hora inicial no sábado
horafinalsabado	Hora final no sábado

33. Endpoint IBPTs (v1)

IBPTs

URL: “/public-api/v1/commons/ibpt“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "registroncm":0, "codigo":"Texto", "descricao":"Texto", "codigoexcecao":"Texto", "aliquotanacionalfederal":"0.00", "aliquotaimportadofederal":"0.00", "aliquotaestadual":"0.00", "aliquotamunicipal":"0.00", "datainicio":"yyyy-MM-dd", "datafim":"yyyy-MM-dd", "idestado":1, "chaveestado":"Texto", "fonte":"Texto", "versao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/ibpt

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/ibpt/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
registroncm	NCM		Inteiro			0 – Produto; 1 – Serviço – NBS; 2 – Serviço – Lei complementar.
codigo	Código		Caractere	10
descricao	Descrição do IBPT		Caractere	500
codigoexcecao	Código de exceção de NCM – de acordo com a tabela de incidência do imposto de produtos industrializados (TIPI)		Caractere	3
aliquotanacionalfederal	Alíquota da unidade federal		Decimal	5	2
aliquotaimportadofederal	Alíquota da importação federal		Decimal	5	2
aliquotaestadual	Alíquota da unidade estadual		Decimal	5	2
aliquotamunicipal	Alíquota da unidade municipal		Decimal	5	2
datainicio	Data inicial
datafim	Data final
idestado	ID do estado		Inteiro
chaveestado	Chave estado		Caractere	6
fonte	Fonte		Caractere	50
versao	Versão do arquivo		Caractere	10

34. Endpoint Informações adicionais de apuração (v1)

Informações adicionais de apuração

URL: “/public-api/v1/commons/informacaoadicionalapuracao“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "descricao":"Texto", "periodo":"yyyy-MM-dd", "idtipoinformacaoadicional":1, "valor":"0.00"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/informacaoadicionalapuracao

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
descricao	Descrição		Caractere	100
periodo	Período
idtipoinformacaoadicional	ID do tipo da informação adicional		Inteiro
valor	Valor		Decimal	12	2

35. Endpoint Informações complementares de produto por filial (v1)

Informações complementares de produto por filial

URL: “/public-api/v1/commons/complementoprodutofilial“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idfilial":1, "idproduto":1, "endereco":"Texto", "quantidademinima":"0.000000", "quantidademaxima":"0.000000", "alertarestoqueforalimite":0, "alertarestoquezero":0, "alertarestoquenegativo":0}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idfilial	ID da filial		Inteiro
idproduto	ID do produto		Inteiro
endereco	Endereço do produto no estoque		Caractere	50
quantidademinima	Quantidade mínima no estoque		Decimal	15	6
quantidademaxima	Quantidade máxima no estoque		Decimal	15	6
alertarestoqueforalimite	Avisar na central de pendências sobre estoque fora dos limites		Inteiro			0 – Não; 1 – Sim.
alertarestoquezero	Avisar na central de pendências sobre estoque zerado		Inteiro			0 – Não; 1 – Sim.
alertarestoquenegativo	Avisar na central de pendências sobre estoque negativo		Inteiro			0 – Não; 1 – Sim.

36. Endpoint Locais de estoque (v1)

Locais de estoque

URL: “/public-api/v1/commons/localestoque“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idfilial":1, "codigo":"Texto", "descricao":"Texto", "tipo":0, "posse":"Texto", "inativo":0, "enviarsaldoestoqueecommerce":0, "alertarestoque":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/localestoque

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/localestoque/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idfilial	ID da filial		Inteiro
codigo	Código		Caractere	5
descricao	Descrição		Caractere	50
tipo	Tipo de local de estoque		Inteiro			3 – Interno; 4 – Terceiros.
posse	Posse do item		Caractere	1		0 – Item de propriedade do informante e em seu poder; 1 – Item de propriedade do informante e em posse de terceiros; 2 – Item de propriedade de terceiros em posse do informante.
inativo	Inativo		Inteiro			0 – Não; 1 – Sim.
enviarsaldoestoqueecommerce	Enviar saldo de estoque para o e-commerce		Inteiro			0 – Não; 1 – Sim.
alertarestoque	Exibir alertas desse local de estoque na central de pendências		Inteiro			0 – Não; 1 – Sim.

37. Endpoint Locais de retirada (v1)

Locais de retirada

URL: “/public-api/v1/commons/localretirada“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "descricao":"Texto", "tipopessoa":0, "cnpjcpf":"Texto", "razaosocialnome":"Texto", "logradouro":"Texto", "numero":"Texto", "complemento":"Texto", "bairro":"Texto", "cep":"Texto", "idestado":1, "idpais":1, "idcidade":1, "tipotelefone":0, "telefone":"Texto", "email":"Texto", "inscricaoestadual":"Texto", "idfilial":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/localretirada

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/localretirada/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
descricao	Descrição		Caractere	60
tipopessoa	Tipo		Inteiro
cnpjcpf	CNPJ/CPF		Caractere	20
razaosocialnome	Razão social/Nome		Caractere	60
logradouro	Endereço		Caractere	60
numero	Número do endereço		Caractere	60
complemento	Complemento do endereço		Caractere	60
bairro	Bairro		Caractere	60
cep	CEP		Caractere	9
idestado	Estado		Inteiro
idpais	País		Inteiro
idcidade	Cidade		Inteiro
tipotelefone	Tipo de telefone		Inteiro			0 – Telefone; 1 – Celular
telefone	Telefone		Caractere	40
email	E-mail		Caractere	60
inscricaoestadual	Inscrição estadual		Caractere	20
idfilial	ID da filial		Inteiro

38. Endpoint Marcas dos fabricantes (v1)

Marcas dos fabricantes

URL: “/public-api/v1/commons/marca“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idfabricante":1, "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/marca

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/marca/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idfabricante	ID do fabricante		Inteiro
descricao	Descrição da marca		Caractere	120

39. Endpoint Meios de pagamento (finalizadores) (v1)

Meios de pagamento (finalizadores)

URL: “/public-api/v1/commons/finalizador“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "abreviacao":"Texto", "tecla":0, "nome":"Texto", "entrada":0, "troco":0, "integracao":0, "tipodocumento":0, "venda":0, "recebimento":0, "cartaofidelidade":0, "recargacelular":0, "sangria":0, "valepresente":0, "adiantamento":0, "prepago":0, "ticketrefeicao":0, "garantiaestendida":0, "cliente":0, "tipoparcela":0, "valor":0, "imprimecheque":0, "tipoverificacao":0, "cpf":0, "data":0, "banco":0, "agencia":0, "conta":0, "emitente":0, "maximoparcelas":0, "tipodocumentoretaguarda":"Texto", "idtipodocumentodebito":1, "tipocobrancaretaguarda":"Texto", "tipovencimento":0, "tipoimpressao":0, "tiporetaguarda":0, "tipocartaoproprio":0, "formatocontaspagar":0, "valormaximo":"0.00", "tipoedicaoparcela":0, "pularparames":0, "doacao":0, "teclavenda":0, "teclarecebimento":0, "teclavalepresente":0, "diasuso":0, "quantidademaxima":0, "cartaofidelidadevalor":"0.00", "cartaofidelidadepontos":0, "modelocomprovante":"Texto", "valorminimoparcela":"0.00", "cadastracliente":0, "formapagamentonfce":"Texto", "linhasentreparcelas":0, "idplanoconta":1, "informarautorizacaopos":0, "agruparcentavosprimeiraparcela":0, "enviarmobilepdv":0, "finalizadorrapido":0, "enviaruniplusshop":0, "taxa":"0.00", "idadministradoracartao":1, "nomerede":"Texto", "idcontacorrente":1, "idtipodocumentovoucher":1, "percentualdesconto":"0.00", "percentualacrescimo":"0.00"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/finalizador

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/finalizador/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
abreviacao	Abreviação do nome		Caractere	20
tecla	Número da tecla de função		Inteiro
nome	Nome		Caractere	50
entrada	Habilitado para entrada de financiamento		Inteiro
troco	Identifica se o meio de pagamento permite troco		Inteiro
integracao	Tipo de Integração		Inteiro
tipodocumento	Tipo do documento		Inteiro
venda	Habilita o meio de pagamento para a operacao de venda		Inteiro
recebimento	Habilita o meio de pagamento para a operação de recebimento		Inteiro
cartaofidelidade	Habilita o meio de pagamento para a operação de resgate de produto do cartão fidelidade		Inteiro
recargacelular	Habilita o meio de pagamento para a operação de recarga de celular		Inteiro
sangria	Habilita o meio de pagamento para a operação de sangria		Inteiro
valepresente	Habilita o meio de pagamento para a operação de vale presente		Inteiro
adiantamento	Habilita o meio de pagamento para a operação de adiantamento		Inteiro
prepago	Habilita o meio de pagamento para a operação de Pré-pago		Inteiro
ticketrefeicao	Habilita o meio de pagamento para a operação de Ticket refeição		Inteiro
garantiaestendida	Habilita o meio de pagamento para a operação de garantia estendida		Inteiro
cliente	Identifica o cliente na operação		Inteiro
tipoparcela	Tipo da parcela		Inteiro
valor	Informa o valor do meio de pagamento		Inteiro
imprimecheque	Imprime cheque para o meio de pagamento		Inteiro
tipoverificacao	Tipo da verificação		Inteiro
cpf	Identifica o CPF do cliente		Inteiro
data	Identifica a data de emissão		Inteiro
banco	Edita número do banco quando tipo do finalizador for cheque		Inteiro
agencia	Edita número da agencia quando tipo do finalizador for cheque		Inteiro
conta	Edita número da conta quando tipo do finalizador for cheque		Inteiro
emitente	Edita o nome do emitente quando tipo do finalizador for cheque		Inteiro
maximoparcelas	Número máximo parcelas		Inteiro
tipodocumentoretaguarda	tipodocumentoretaguarda		Caractere	3
idtipodocumentodebito	Id do Tipo de documento financeiro quando for venda em TEF debito		Inteiro
tipocobrancaretaguarda	Tipo de cobrança na retaguarda		Caractere	3
tipovencimento	Tipo de vencimento		Inteiro
tipoimpressao	Tipo de impressão		Inteiro
tiporetaguarda	Tipo da retaguarda		Inteiro
tipocartaoproprio	Tipo do cartão próprio		Inteiro
formatocontaspagar	Formato contas a pagar		Inteiro
valormaximo	Valor máximo permitido		Decimal	12	2
tipoedicaoparcela	Tipo edição parcela		Inteiro
pularparames	Identifica se o meio de pagamento pula o mês para da promoção		Inteiro
doacao	Habilita o meio de pagamento para de doação		Inteiro
teclavenda	Número da tecla de função quando venda ou 0=default		Inteiro
teclarecebimento	Número da tecla de função quando recebimento ou 0=default		Inteiro
teclavalepresente	Número da tecla de função quando vale presente ou 0=default		Inteiro
diasuso	Número de dias para uso do documento		Inteiro
quantidademaxima	Quantidade máxima permitida		Inteiro
cartaofidelidadevalor	O valor base para cálculo de pontos do cartão fidelidade		Decimal	12	2
cartaofidelidadepontos	Número de pontos para o cartão fidelidade, conforme o valor definido		Inteiro
modelocomprovante	Modelo de impressão do comprovante		Caractere
valorminimoparcela	Valor mínimo da parcela		Decimal	12	2
cadastracliente	Possibilita cadastrar cliente caso ele não exista		Inteiro
formapagamentonfce	Forma de pagamento para a NFC-e		Caractere	2
linhasentreparcelas	Quantidade de linhas que irão separar uma parcela da outra		Inteiro
idplanoconta	ID do plano de conta		Inteiro
informarautorizacaopos	Informar número de autorização do POS		Inteiro
agruparcentavosprimeiraparcela	Agrupa os centavos das demais parcelas na primeira		Inteiro
enviarmobilepdv	Enviar finalizador para mobile PDV		Inteiro
finalizadorrapido	Define como finalizador rápido no mobile PDV		Inteiro
enviaruniplusshop	Enviar finalizador Uniplus shop		Inteiro
taxa	Percentual da taxa cobrada pelo meio de pagamento		Decimal	5	2
idadministradoracartao	ID da administradora cartão/Carteira digital		Inteiro
nomerede	Nome da administradora cartão/Carteira digital		Caractere	50
idcontacorrente	ID da conta corrente		Inteiro
idtipodocumentovoucher	ID do Tipo de documento financeiro quando for venda em TEF voucher		Inteiro
percentualdesconto	Percentual desconto aplicado para o meio de pagamento		Decimal	5	2
percentualacrescimo	Percentual acréscimo aplicado para o meio de pagamento		Decimal	5	2

40. Endpoint Meios de transporte de cargas (v1)

Meios de transporte de cargas

URL: “/public-api/v1/commons/meiotransporte“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "tipotransporte":0, "placaveiculo":"Texto", "idtransportadora":1, "tipoveiculo":"Texto", "tiporodado":"Texto", "tipocarroceria":"Texto", "idestadolicenciamento":1, "capacidadem3":0, "capacidadekg":0, "tarakg":0, "renavan":"Texto", "tipoproprietario":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/meiotransporte

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/meiotransporte/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código do meio de transporte		Caractere	20
descricao	Descrição do meio de transporte		Caractere	255
tipotransporte	Tipo de transporte		Inteiro			0 – Próprio; 1 – Terceiro.
placaveiculo	Placa do veículo		Caractere	10
idtransportadora	ID da transportadora		Inteiro
tipoveiculo	Tipo do veículo		Caractere	1		0 – Tração; 1 – Reboque.
tiporodado	Tipo do rodado		Caractere	2		00 – Não aplicável; 01 – Truck; 02 – Toco; 03 – Cavalo Mecânico; 04 – VAN; 05 – Utilitário; 06 – Outros.
tipocarroceria	Tipo da carroceria		Caractere	2		00 – Não aplicável; 01 – Aberta; 02 – Fechada/Baú; 03 – Granelera; 04 – Porta Container; 05 – Sider.
idestadolicenciamento	Estado do licenciamento		Inteiro
capacidadem3	Capacidade M3		Inteiro
capacidadekg	Capacidade KG		Inteiro
tarakg	Tara KG		Inteiro
renavan	Renavan		Caractere	11
tipoproprietario	Tipo proprietário		Caractere	1		0 – TAC – Agregado; 1 – TAC Independente; 2 – Outros.

41. Endpoint Motivos de acerto de estoque (v1)

Motivos de acerto de estoque

URL: “/public-api/v1/commons/tipodocumentoestoque“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "descricao":"Texto", "operacao":0, "movimentacao":0, "valorizacao":0, "basecalculocustomedio":0, "centrocustoobrigatorio":0, "idplanocontas":1, "controleperda":0, "idcfopcontroleperda":1, "gerark280":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipodocumentoestoque

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipodocumentoestoque/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
descricao	Descrição		Caractere	55
operacao	Operação		Inteiro			0 – 1 – Entrada; 2 – Saída; 3 – Transferência.
movimentacao	Movimenta		Inteiro			1 – Somente quantidade; 2 – Somente valor; 3 – Quantidade e valor.
valorizacao	Tipo da valorização		Inteiro			1 – Nenhum; 2 – Preço de compra; 3 – Custo de compra; 4 – Custo médio; 5 – Custo digitado; 6 – Custo Inicial.
basecalculocustomedio	Será utilizado na base de cálculo do custo médio		Inteiro			0 – Não; 1 – Sim.
centrocustoobrigatorio	O centro de custo precisa ser informado?		Inteiro			0 – Não; 1 – Sim.
idplanocontas	ID do plano de contas		Inteiro
controleperda	O motivo de ajuste de estoque é usado para controle de perdas?		Inteiro			0 – Não; 1 – Sim.
idcfopcontroleperda	ID da CFOP utilizada para controle de perdas		Inteiro
gerark280	Gerar registro K280 do SPED Fiscal		Inteiro			0 – Não; 1 – Sim.

42. Endpoint Motivos de baixas do financeiro (v1)

Motivos de baixas do financeiro

URL: “/public-api/v1/commons/motivobaixafinanceiro“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/motivobaixafinanceiro

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código do motivo		Caractere	6
descricao	Descrição do motivo		Caractere	60

43. Endpoint Motivos de cancelamento de operações do PDV (v1)

Motivos de cancelamento de operações do PDV.

URL: “/public-api/v1/commons/motivocancelamentooperacao“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "descricao":"Texto"}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
descricao	Descrição do motivo		Caractere	50

44. Endpoint Motivos de desconto (v1)

Motivos de desconto

URL: “/public-api/v1/commons/motivodesconto“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "nome":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/motivodesconto

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/motivodesconto/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
nome	Descrição		Caractere	50

45. Endpoint Motivos de rebaixa (v1)

Motivos de rebaixa

URL: “/public-api/v1/commons/motivorebaixa“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/motivorebaixa

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/motivorebaixa/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caratere	6
nome	Descrição		Caractere	50

46. Endpoint Motivos de sangria ou suprimento (v1)

Motivos de sangria ou suprimento

URL: “/public-api/v1/commons/motivosangriasuprimento“
Verbos suportados: GET

JSON Exemplo

{"id":1, "codigo":0, "descricao":"Texto", "sangria":0, "idplanocontas":1}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
descricao	Descrição		Caracter	40
sangria	Identifica que o motivo vai ser utilizado apenas na sangria		Inteiro			0 – Suprimento; 1 – Sangria; 2 – Sobra de caixa; 3 – Falta de caixa.
idplanocontas	ID do Plano de contas		Inteiro

47. Endpoint Naturezas de operações fiscais (v1)

Naturezas de operações fiscais

URL: “/public-api/v1/commons/cfop“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cfop

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/cfop/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	20
descricao	Descrição		Caractere	1024

48. Endpoint Notas fiscais da desmontagem (v1)

Notas fiscais da desmontagem

URL: “/public-api/v1/commons/desmontagemnotafiscal“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "iddesmontagem":1, "idnotafiscal":1}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
iddesmontagem	ID da desmontagem		Inteiro
idnotafiscal	ID da nota fiscal gerada		Inteiro

49. Endpoint Observações de Lançamentos fiscais (v1)

Observações de Lançamentos fiscais

URL: “/public-api/v1/commons/observacaolancamentofiscal“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "tipobase":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/observacaolancamentofiscal

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código da observação		Caractere	6
descricao	Descrição da observação		Caractere
tipobase	Tipo base cálculo		Inteiro

50. Endpoint País (v1)

País

URL: “/public-api/v1/commons/pais“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "nome":"Texto", "codigoibge":0, "codigosiscomex":0, "isoalpha2":"Texto", "isoalpha3":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pais

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pais/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
nome	Nome do país, de acordo com padrão IBGE		Caractere	60
codigoibge	Código do pais, de acordo com tabela do Banco Central		Inteiro
codigosiscomex	Código do país no SISCOMEX		Inteiro
isoalpha2	Código do ISO 3166-1 alpha 2		Caractere	2
isoalpha3	Código do ISO 3166-1 alpha 3		Caractere	3

51. Endpoint Pautas de preço (v1)

Pautas de preço

URL: “/public-api/v1/commons/pautapreco“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "comissao":"0.00", "comissaoquitacao":"0.00", "comissaoavista":"0.00", "comissaoaprazo":"0.00", "inativo":0, "flex":0, "enviamobilepdv":0, "enviamobilevendas":0, "ativarpdv":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pautapreco

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pautapreco/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código da pauta		Caractere	20
nome	Nome da pauta		Caractere	60
comissao	Percentual de comissão		Decimal	5	2
comissaoquitacao	Percentual de comissão gerada ao ser quitada uma duplicata		Decimal	5	2
comissaoavista	Percentual de comissão para vendas à vista		Decimal	5	2
comissaoaprazo	Percentual de comissão para vendas a prazo		Decimal	5	2
inativo	Inativo		Inteiro
flex	Enviar flex		Inteiro
enviamobilepdv	Enviar para mobile		Inteiro
enviamobilevendas	Enviar para mobile vendas		Inteiro
ativarpdv	Ativar no PDV		Inteiro

52. Endpoint Pautas de preço por filial (v1)

Pautas de preço por filial

URL: “/public-api/v1/commons/pautaprecofilial“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idpauta":1, "idfilial":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pautaprecofilial

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pautaprecofilial/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idpauta	ID da pauta		Inteiro
idfilial	ID da filial		Inteiro

53. Endpoint Pedidos de compra (v1)

Pedidos de compra

URL: “/public-api/v1/commons/pedidocompra“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "codigo":0, "idfilial":1, "idfornecedor":1, "idcomprador":1, "status":0, "valortotal":"0.00", "dataemissao":"yyyy-MM-dd", "dataprevisaoentrega":"yyyy-MM-dd", "datafaturamento":"yyyy-MM-dd", "idcondicaopagamento":1, "desconto":"0.00", "observacao":"Texto", "idusuario":1, "idusuariofaturamento":1, "idnotafiscal":1, "idpedidocomprapai":1, "idpedidocompraprincipal":1, "valoricmsst":"0.00", "valoripi":"0.00", "valortotalgeral":"0.00", "idcfop":1, "idoperacaofiscal":1, "idtransportadora":1, "frete":"0.00", "tipofrete":0, "extra1":"Texto", "extra2":"Texto", "extra3":"Texto", "extra4":"Texto", "extra5":"Texto", "extra6":"Texto", "extra7":"Texto", "extra8":"Texto", "extra9":"Texto", "extra10":"Texto", "extra11":"Texto", "extra12":"Texto", "extra13":"Texto", "extra14":"Texto", "extra15":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pedidocompra

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pedidocompra/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
idfilial	ID da filial		Inteiro
idfornecedor	ID do fornecedor		Inteiro
idcomprador	ID do comprador		Inteiro
status	Status		Inteiro			0 – Não faturado; 1 – Faturado; 2 – Faturado parcialmente; 3 – Mesclado.
valortotal	Valor		Decimal	12	2
dataemissao	Data de emissão
dataprevisaoentrega	Previsão de entrega
datafaturamento	Previsão de faturamento
idcondicaopagamento			Inteiro
desconto	Desconto		Decimal	12	2
observacao			Caractere
idusuario	ID do usuário		Inteiro
idusuariofaturamento	ID do usuário de faturamento		Inteiro
idnotafiscal	ID da nota fiscal		Inteiro
idpedidocomprapai	ID do pedido de compra pai		Inteiro
idpedidocompraprincipal	ID do pedido de compra principal		Inteiro
valoricmsst	Valor ICMS ST		Decimal	12	2
valoripi	Valor IPI		Decimal	12	2
valortotalgeral	Valor total geral do pedido de compra		Decimal	12	2
idcfop	ID da natureza de operação		Inteiro
idoperacaofiscal	Operação fiscal		Inteiro
idtransportadora	ID da transportadora		Inteiro
frete	Valor do frete		Decimal	12	2
tipofrete	Tipo de frete		Inteiro			0 – Contratação do Frete por conta do Emitente (CIF); 1 – Contratação do Frete por conta do Destinatário (FOB); 2 – Contratação do Frete por conta de Terceiros; 3 – Transporte Próprio por conta do Remetente; 4 – Transporte Próprio por conta do Destinatário; 9 – Sem Ocorrência de Transporte
extra1	Campo extra 1 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra2	Campo extra 2 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra3	Campo extra 3 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra4	Campo extra 4 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra5	Campo extra 5 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra6	Campo extra 6 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra7	Campo extra 7 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra8	Campo extra 8 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra9	Campo extra 9 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra10	Campo extra 10 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra11	Campo extra 11 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra12	Campo extra 12 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra13	Campo extra 13 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra14	Campo extra 14 (campo utilizado para guardar uma informação qualquer)		Caractere	512
extra15	Campo extra 15 (campo utilizado para guardar uma informação qualquer)		Caractere	512

54. Endpoint Pedidos de compra – itens (v1)

Pedidos de compra – itens

URL: “/public-api/v1/commons/pedidocompraitem“
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idpedidocompra":1, "idpedidocompraitempai":1, "idpedidocompraitemprincipal":1, "nritem":0, "quantidade":"0.000000", "preco":"0.000000", "precoinformado":"0.000000", "idproduto":1, "total":"0.00", "desconto":"0.00", "observacao":"Texto", "variacoes":"Texto", "numeroserie":"Texto", "brinde":0, "percentualdesconto":"0.00", "descontopromocao":"0.00", "idmotivodesconto":1, "idcfop":1, "situacaotributaria":"Texto", "situacaotributariasn":"Texto", "modalidadeicmsst":0, "percentualreducaomva":"0.00", "ipi":"0.000", "fatorconversao":"0.000000", "idembalagem":1, "idunidademedida":1, "percredbasepiscofins":"0.00", "basepis":"0.00", "basecofins":"0.00", "aliquotapis":"0.0000", "aliquotacofins":"0.0000", "pis":"0.00", "cofins":"0.00", "cstpis":"Texto", "cstcofins":"Texto", "idtipocredito":1, "idreceitasemcontribuicao":1, "idcontribuicaosocialapurada":1, "idcontribuicaosocialapurcofins":1, "situacaotributariaipi":"Texto", "modocalculoipi":0, "baseipi":"0.00", "percentualipi":"0.0000", "percentualipinaodestacado":"0.0000", "ipinaodestacado":"0.00", "percentualreducaoicms":"0.000000", "baseicms":"0.00", "percentualicms":"0.00", "icms":"0.00", "percentualicmsaproveitamento":"0.0000", "valoricmsaproveitamento":"0.00", "percentualicmsdiferido":"0.00", "icmsdiferido":"0.00", "percentualreducaoicmsdiferido":"0.00", "baseicmsdiferido":"0.00", "percentualicmssubstituicao":"0.00", "percreducaoicmssubstituicao":"0.00", "margemvaloradicionado":"0.00", "baseicmssubstituicao":"0.00", "icmssubstituicao":"0.00", "cargatributariamedia":"0.00", "baseicmsstanterior":"0.00", "valoricmsstanterior":"0.00", "valoricmssubstituto":"0.00", "basestufdestino":"0.00", "valorstufdestino":"0.00", "percentualfunrural":"0.00", "funrural":"0.00", "percimpostoaproximado":"0.00", "baseimpostoaproximado":"0.00", "chaveibpt":"Texto", "percimpostoaproximadomunicipal":"0.00", "impostoaproximadomunicipal":"0.00", "percimpostoaproximadoestadual":"0.00", "impostoaproximadoestadual":"0.00", "percimpostoaproximadofederal":"0.00", "impostoaproximadofederal":"0.00", "fonteibpt":"Texto", "impostoaproximado":"0.00", "valorimpostosincentivados":"0.00", "valorpisincentivado":"0.00", "valorcofinsincentivado":"0.00", "valoricmsincentivado":"0.00", "aliquotapisincentivado":"0.00", "aliquotacofinsincentivado":"0.00", "aliquotaicmsincentivado":"0.00", "percentualiss":"0.0000", "baseiss":"0.00", "percentualreducaoiss":"0.0000", "iss":"0.00", "percentualretencaoiss":"0.0000", "retencaoiss":"0.00", "perccontribuicaosocial":"0.00", "contribuicaosocial":"0.00", "percimpostorenda":"0.00", "impostorenda":"0.00", "baseimpostorenda":"0.00", "basecontribuicaosocial":"0.00", "aliquotareducaobasecalculoinss":"0.00", "baseinss":"0.00", "percinss":"0.00", "inss":"0.00", "descontosubtotal":"0.00", "frete":"0.00", "seguro":"0.00", "outrasdespesas":"0.00", "impostoimportacao":"0.00", "iof":"0.00", "despesasaduaneiras":"0.00", "veiculonovo":0, "tipokit":0, "taxasiscomex":"0.00", "valorafrmm":"0.00", "tributacao":"Texto", "baseimpostoimportacao":"0.00", "motivodesoneracaoicms":0, "motivodesoneracaopis":0, "motivodesoneracaocofins":0, "enviartagsdiferimentototal":0, "origem":0, "valordiferencaimportacaoxml":"0.00", "percentualicmsdestino":"0.00", "percentualicmsinterestadual":"0.00", "icmsdestino":"0.00", "icmsremetente":"0.00", "percentualpartilhaicmsestados":"0.00", "basecalculoicmsdifal":"0.00", "percentualicmsfundopobreza":"0.00", "icmsfundopobreza":"0.00", "basefundopobrezast":"0.00", "percentualicmsfundopobrezast":"0.00", "icmsfundopobrezast":"0.00", "basefundopobrezainterno":"0.00", "percicmsfundopobrezainterno":"0.00", "icmsfundopobrezainterno":"0.00", "basefcpstanterior":"0.00", "valorfcpstanterior":"0.00", "idenquadramentoipi":1, "naopossuiicmsstnotaorigem":0, "aliquotapisretido":"0.00", "aliquotacofinsretido":"0.00", "basepisretido":"0.00", "basecofinsretido":"0.00", "pisretido":"0.00", "cofinsretido":"0.00", "valoricmsdiferencialentrada":"0.00", "aliquotaicmsdiferencialentrada":"0.00", "idobservacaolancamentofiscal":1, "idajustedocumentofiscal":1, "baseicmsefetivo":"0.00", "aliquotaicmsefetivo":"0.00", "percentualredbaseicmsefetivo":"0.0000", "valoricmsefetivo":"0.00", "aliquotafcpstanterior":"0.00", "aliquotaicmsstanterior":"0.00", "informacaoadicional":"Texto", "motivodesoneracaoicmssemdesc":0, "baseicmsdesoneradosemdesconto":"0.00", "aliquotaicmsdesoneradosemdesc":"0.00", "valoricmsdesoneradosemdesconto":"0.00", "baseicmsstpresumido":"0.00", "aliquotaicmsstpresumido":"0.00", "valoricmsstpresumido":"0.00", "baseicmspresumido":"0.00", "aliquotaicmspresumido":"0.00", "valoricmspresumido":"0.00", "percentualreducaoicmsvirtual":"0.000000", "baseicmsvirtual":"0.00", "percentualicmsvirtual":"0.00", "icmsvirtual":"0.00", "basefundopobrezainternovirtual":"0.00", "percicmsfundopobinternovirtual":"0.00", "icmsfundopobrezainternovirtual":"0.00", "deducaoicmsbasepis":"0.00", "deducaoicmsbasecofins":"0.00", "baseicmsmonoproprio":"0.0000", "aliquotaicmsmonoproprio":"0.0000", "valoricmsmonoproprio":"0.00", "baseicmsmonoretencao":"0.0000", "aliquotaicmsmonoretencao":"0.0000", "valoricmsmonoretencao":"0.00", "baseicmsmonodiferido":"0.0000", "aliquotaicmsmonodiferido":"0.0000", "valoricmsmonodiferido":"0.00", "baseicmsmonoretanterior":"0.0000", "aliquotaicmsmonoretanterior":"0.0000", "valoricmsmonoretanterior":"0.00", "tributacaoissnacional":"Texto", "numerobeneficioissnacional":"Texto", "tiposuspensaoissnacional":"Texto", "tipoimunidadeissnacional":"Texto", "tiporetencaoissnacional":"Texto", "numeroprocessoissnacional":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pedidocompraitem

Lista dos campos do JSON

Identificador

Descrição

Obrigatório

Tipo

Tamanho

Decimais

Observações

Inteiro

idpedidocompra

ID do pedido de compra

Inteiro

idpedidocompraitempai

ID do pedido de compra item pai

Inteiro

idpedidocompraitemprincipal

ID do pedido de compra item principal

Inteiro

nritem

Número do item

Inteiro

quantidade

Quantidade do item

Decimal

preco

Preço do item

Decimal

precoinformado

Preço unitário informado ao incluir o item

Decimal

idproduto

ID do produto

Inteiro

total

Valor total

Decimal

desconto

Desconto

Decimal

observacao

Observação

Caractere

variacoes

Variações

Caractere

4069

numeroserie

Número de série

Caractere

brinde

Brinde

Inteiro

percentualdesconto

Percentual de desconto

Decimal

descontopromocao

Desconto da promoção

Decimal

idmotivodesconto

ID do motivo de desconto

Inteiro

idcfop

ID da natureza de operação

Inteiro

situacaotributaria

Situação tributária do ICMS

Caractere

situacaotributariasn

Situação tributária do ICMS para Simples nacional

Caractere

modalidadeicmsst

Modalidade de determinação da base de cálculo do ICMS de substituição

Inteiro

0 –
4 – Margem valor agregado (%);
5 – Pauta (valor);
6 – Valor da operação;
9 – Carga tributária média.

percentualreducaomva

Percentual de redução de MVA

Decimal

ipi

Valor do IPI

Decimal

fatorconversao

Fator de conversão

Decimal

idembalagem

ID da embalagem

Inteiro

idunidademedida

Inteiro

percredbasepiscofins

Percentual de redução da base de PIS/COFINS

Decimal

basepis

Valor base PIS

Decimal

basecofins

Valor base COFINS

Decimal

aliquotapis

Alíquota PIS

Decimal

aliquotacofins

Alíquota COFINS

Decimal

pis

Valor PIS

Decimal

cofins

Valor COFINS

Decimal

cstpis

CST PIS

Caractere

cstcofins

CST COFINS

Caractere

idtipocredito

Tipo de crédito

Inteiro

idreceitasemcontribuicao

Receita sem contribuição

Inteiro

idcontribuicaosocialapurada

Contribuição social apurada

Inteiro

idcontribuicaosocialapurcofins

Contribuição social apurada cofins

Inteiro

situacaotributariaipi

Situação tributária do IPI

Caractere

modocalculoipi

Modo de cálculo do IPI

Inteiro

baseipi

Base de cálculo do IPI

Decimal

percentualipi

Percentual do IPI

Decimal

percentualipinaodestacado

Percentual do IPI não destacado

Decimal

ipinaodestacado

Valor do IPI não destacado

Decimal

percentualreducaoicms

Percentual de redução do ICMS

Decimal

baseicms

Valor da base de cálculo do ICMS

Decimal

percentualicms

Percentual do ICMS

Decimal

icms

Valor do icms

Decimal

percentualicmsaproveitamento

Percentual de aproveintameto de ICMS

Decimal

valoricmsaproveitamento

Percentual de aproveintameto de ICMS

Decimal

percentualicmsdiferido

Percentual do icms diferido

Decimal

icmsdiferido

Valor do ICMS

Decimal

percentualreducaoicmsdiferido

Percentual de redução do ICMS diferido

Decimal

baseicmsdiferido

Valor da base de cálculo do ICMS diferido

Decimal

percentualicmssubstituicao

Percentual do ICMS de substituição

Decimal

percreducaoicmssubstituicao

Percentual do ICMS de substituição

Decimal

margemvaloradicionado

Margem do valor adicionado

Decimal

baseicmssubstituicao

Valor base do ICMS de retenção na substituição tributaria

Decimal

icmssubstituicao

Valor da retenção de ICMS

Decimal

cargatributariamedia

Valor da carga tributária média

Decimal

baseicmsstanterior

Valor da base de ICMS ST cobrado anteriormente

Decimal

valoricmsstanterior

Valor do ICMS ST cobrado anteriormente

Decimal

valoricmssubstituto

Valor do ICMS substituto

Decimal

basestufdestino

Valor da BC do ICMS ST da UF destino

Decimal

valorstufdestino

Valor do ICMS ST da UF destino

Decimal

percentualfunrural

Percentual FUNRURAL

Decimal

funrural

Valor do FUNRURAL

Decimal

percimpostoaproximado

Percentual de imposto aproximado

Decimal

baseimpostoaproximado

Base de cálculo para o imposto aproximado

Decimal

chaveibpt

Chave estado

Caractere

percimpostoaproximadomunicipal

Percentual de imposto aproximado municipal

Decimal

impostoaproximadomunicipal

Valor do imposto aproximado municipal

Decimal

percimpostoaproximadoestadual

Percentual de imposto aproximado estadual

Decimal

impostoaproximadoestadual

Valor do imposto aproximado estadual

Decimal

percimpostoaproximadofederal

Percentual de imposto aproximado federal

Decimal

impostoaproximadofederal

Valor do imposto aproximado federal

Decimal

fonteibpt

Fonte

Caractere

impostoaproximado

Valor do imposto aproximado

Decimal

valorimpostosincentivados

Valor dos impostos incentivados

Decimal

valorpisincentivado

Valor do PIS incentivado

Decimal

valorcofinsincentivado

Valor do COFINS incentivado

Decimal

valoricmsincentivado

Valor do ICMS incentivado

Decimal

aliquotapisincentivado

Percentual do PIS incentivado

Decimal

aliquotacofinsincentivado

Percentual do COFINS incentivado

Decimal

aliquotaicmsincentivado

Percentual do ICMS incentivado

Decimal

percentualiss

Percentual de ISS

Decimal

baseiss

Base de cálculo do iss

Decimal

percentualreducaoiss

Percentual de redução do ISS

Decimal

iss

Valor do ISS

Decimal

percentualretencaoiss

Percentual retenção de ISS

Decimal

retencaoiss

Valor retenção de ISS

Decimal

perccontribuicaosocial

Percentual de contribuição social

Decimal

contribuicaosocial

Contribuição social

Decimal

percimpostorenda

Percentual de imposto de renda

Decimal

impostorenda

Imposto de renda

Decimal

baseimpostorenda

Base do imposto de renda

Decimal

basecontribuicaosocial

Base da CSLL

Decimal

aliquotareducaobasecalculoinss

Percentual Redução base de cálculo do INSS

Decimal

baseinss

Base de cálculo do INSS

Decimal

percinss

Percentual de INSS

Decimal

inss

Valor de INSS

Decimal

descontosubtotal

Valor rateado do desconto do subtotal da nota

Decimal

frete

Valor do frete

Decimal

seguro

Valor do seguro

Decimal

outrasdespesas

Valor de outras despesas

Decimal

impostoimportacao

Valor do imposto de importação

Decimal

iof

Valor do IOF

Decimal

despesasaduaneiras

Valor das despesas aduaneiras

Decimal

veiculonovo

0=Não;
1=Sim.

Inteiro

tipokit

0=Sem kit;
1=Kit pai;
2=Componente do kit.

Inteiro

taxasiscomex

Valor da taxa SISCOMEX

Decimal

valorafrmm

Valor AFRMM

Decimal

tributacao

Tipo de tributação item

Caractere

baseimpostoimportacao

Valor da base de cálculo do imposto de importação

Decimal

motivodesoneracaoicms

Motivo de desoneração do ICMS

Inteiro

motivodesoneracaopis

Motivo de desoneração do PIS

Inteiro

motivodesoneracaocofins

Motivo de desoneração do COFINS

Inteiro

enviartagsdiferimentototal

Enviar informações de diferimento total na NF-e

Inteiro

0 – Não;
1 – Sim.

origem

Origem do produto

Inteiro

valordiferencaimportacaoxml

Diferença do total do item na importação do XML

Decimal

percentualicmsdestino

Percentual do ICMS de destino

Decimal

percentualicmsinterestadual

Percentual do ICMS interestadual

Decimal

icmsdestino

Valor do ICMS para o estado de destino

Decimal

icmsremetente

Valor do ICMS para o estado do remetente

Decimal

percentualpartilhaicmsestados

Percentual do ICMS de partilha entre os estados

Decimal

basecalculoicmsdifal

Base de cálculo de ICMS do DIFAL

Decimal

percentualicmsfundopobreza

Percentual do ICMS relativo ao fundo de combate à pobreza (FCP) da UF de destino

Decimal

icmsfundopobreza

Valor do ICMS relativo ao fundo de combate à pobreza (FCP) da UF de destino

Decimal

basefundopobrezast

Base do ICMS relativo ao fundo de combate à pobreza ST

Decimal

percentualicmsfundopobrezast

Percentual do ICMS relativo ao fundo de combate à pobreza ST

Decimal

icmsfundopobrezast

Valor do ICMS relativo ao fundo de combate à pobreza ST

Decimal

basefundopobrezainterno

Base do ICMS relativo ao fundo de combate à pobreza interno

Decimal

percicmsfundopobrezainterno

Percentual do ICMS relativo ao fundo de combate à pobreza interno

Decimal

icmsfundopobrezainterno

Valor do ICMS relativo ao fundo de combate à pobreza interno

Decimal

basefcpstanterior

Percentual do ICMS relativo ao fundo de combate à pobreza interno retido anteriormente por ST

Decimal

valorfcpstanterior

Valor do ICMS relativo ao fundo de combate à pobreza interno retido anteriormente por ST

Decimal

idenquadramentoipi

ID do enquadramento do IPI

Inteiro

naopossuiicmsstnotaorigem

Não possui ICMS ST na nota de origem

Inteiro

aliquotapisretido

Percentual retenção PIS

Decimal

aliquotacofinsretido

Percentual retenção COFINS

Decimal

basepisretido

Base retenção PIS

Decimal

basecofinsretido

Base retenção COFINS

Decimal

pisretido

Valor retenção PIS

Decimal

cofinsretido

Valor retenção COFINS

Decimal

valoricmsdiferencialentrada

Valor do ICMS de diferencial de alíquota na entrada

Decimal

aliquotaicmsdiferencialentrada

Percentual do ICMS de diferencial de alíquota na entrada

Decimal

idobservacaolancamentofiscal

Observação do lançamento fiscal

Inteiro

idajustedocumentofiscal

Ajuste do lançamento fiscal

Inteiro

baseicmsefetivo

Base do ICMS efetivo

Decimal

aliquotaicmsefetivo

Percentual ICMS efetivo

Decimal

percentualredbaseicmsefetivo

Percentual de redução da base do ICMS efetiv

Decimal

valoricmsefetivo

Valor do ICMS efetivo

Decimal

aliquotafcpstanterior

Percentual FCP ST anterior

Decimal

aliquotaicmsstanterior

Percentual ICMS ST anterior

Decimal

informacaoadicional

Informação adicional

Caractere

500

motivodesoneracaoicmssemdesc

Motivo desoneração

Inteiro

1 – Taxi;
3 – Uso na agropecuária/Produtor Agropecuário;
4 – Frotista/Locadora;
5 – Diplomático/Consular;
6 – Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações);
7 – SUFRAMA;
8 – Venda a Órgão Público;
9 – Outros;
10 – Deficiente Condutor (Convênio ICMS 38/12);
11 – Deficiente Não Condutor (Convênio ICMS 38/12);
12 – Órgão de fomento e desenvolvimento agropecuário;
90 – Solicitado pelo fisco.

baseicmsdesoneradosemdesconto

Base ICMS desonerado

Decimal

aliquotaicmsdesoneradosemdesc

Percentual ICMS ICM desonerado

Decimal

valoricmsdesoneradosemdesconto

Valor ICMS desonerado

Decimal

baseicmsstpresumido

Base do ICMS ST presumido

Decimal

aliquotaicmsstpresumido

Percentual do ICMS ST presumido

Decimal

valoricmsstpresumido

Valor do ICMS ST presumido

Decimal

baseicmspresumido

Base do ICMS presumido

Decimal

aliquotaicmspresumido

Percentual do ICMS presumido

Decimal

valoricmspresumido

Valor do ICMS presumido

Decimal

percentualreducaoicmsvirtual

Percentual de redução do ICMS virtual

Decimal

baseicmsvirtual

Base do ICMS virtual

Decimal

percentualicmsvirtual

Percentual do ICMS virtual

Decimal

icmsvirtual

Valor do ICMS virtual

Decimal

basefundopobrezainternovirtual

Base do ICMS relativo ao Fundo de Combate à Pobreza interno virtual

Decimal

percicmsfundopobinternovirtual

Percentual do ICMS relativo ao Fundo de Combate à Pobreza interno virtual

Decimal

icmsfundopobrezainternovirtual

Valor do ICMS relativo ao Fundo de Combate à Pobreza interno virtual

Decimal

deducaoicmsbasepis

Valor da dedução do ICMS na base do PIS/COFINS

Decimal

deducaoicmsbasecofins

Valor da dedução do ICMS na base do PIS/COFINS

Decimal

baseicmsmonoproprio

Base ICMS monofásico próprio

Decimal

aliquotaicmsmonoproprio

Percentual ICMS monofásico próprio

Decimal

valoricmsmonoproprio

Valor ICMS monofásico próprio

Decimal

baseicmsmonoretencao

Base ICMS monofásico retenção

Decimal

aliquotaicmsmonoretencao

Percentual ICMS monofásico retenção

Decimal

valoricmsmonoretencao

Valor ICMS monofásico retenção

Decimal

baseicmsmonodiferido

Base ICMS monofásico diferido

Decimal

aliquotaicmsmonodiferido

Percentual ICMS monofásico diferido

Decimal

valoricmsmonodiferido

Valor ICMS monofásico diferido

Decimal

baseicmsmonoretanterior

Base ICMS monofásico retido anteriormente

Decimal

aliquotaicmsmonoretanterior

Percentual ICMS monofásico retido anteriormente

Decimal

valoricmsmonoretanterior

Valor ICMS monofásico retido anteriormente

Decimal

tributacaoissnacional

Tributação ISS NFS-e Nacional

Caractere

1 – Operação tributável;
2 – Imunidade;
3 – Exportação de serviço;
4 – Não Incidência.

numerobeneficioissnacional

Número benefício ISS NFS-e Nacional

Caractere

tiposuspensaoissnacional

Tipo suspensão ISS NFS-e Nacional

Caractere

1 – Exigibilidade Suspensa por Decisão Judicial;
2 – Exigibilidade Suspensa por Processo Administrativo.

tipoimunidadeissnacional

Tipo imunidade ISS NFS-e Nacional

Caractere

0 – Imunidade (tipo não informado na nota de origem;
1 – Patrimônio, renda ou serviços, uns dos outros (CF88, Art 150, VI, a);
2 – Templos de qualquer culto (CF88, Art 150, VI, b);
3 – Patrimônio, renda ou serviços dos partidos políticos, inclusive suas fundações, das entidades sindicais dos trabalhadores, das instituições de educação e de assistência social, sem fins lucrativos, atendidos os requisitos da lei (CF88, Art 150, VI, c);
4 – Livros, jornais, periódicos e o papel destinado a sua impressão (CF88, Art 150, VI, d).

tiporetencaoissnacional

Tipo imunidade ISS NFS-e Nacional

Caractere

1-Não Retido;
2-Retido pelo Tomador;
3-Retido pelo Intermediário.

numeroprocessoissnacional

Número processo ISS NFS-e Nacional

Caractere

55. Endpoint Planos de contas (v1)

Planos de contas

URL: “/public-api/v1/commons/planocontas“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "nome":"Texto", "tipomovimento":"Texto", "tipoconta":0, "inativo":0, "centrocustoobrigatorio":0, "exportaparacontabilidade":0, "idgrupodre":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/planocontas

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/planocontas/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
nome	Descrição		Caractere	40
tipomovimento	E = entrada de recursos; S = saída de recursos.		Caractere	1		S – Saída; E – Entrada.
tipoconta	Tipo da conta		Inteiro			1 – Despesa; 2 – Custo; 3 – Imposto; 9 – Não se aplica.
inativo	Inativo		Inteiro			0 – Não; 1 – Sim.
centrocustoobrigatorio	O centro de custo é obrigatório?		Inteiro
exportaparacontabilidade	Exporta para a contabilidade		Inteiro			0 – Não; 1 – Sim.
idgrupodre	Grupo do DRE		Inteiro

56. Endpoint Produtos similares (v1)

Produtos similares

URL: “/public-api/v1/commons/produtosimilar“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "idproduto":1, "idprodutofilho":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/produtosimilar

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/produtosimilar/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idproduto	ID do produto		Inteiro
idprodutofilho	ID do produto filho		Inteiro

57. Endpoint Promoções (v1)

Promoções

URL: “/public-api/v1/commons/promocao“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "inativo":0, "datainicial":"yyyy-MM-dd", "datafinal":"yyyy-MM-dd", "idtabelafinanciamento":1, "comissao":"0.00", "comissaoavista":"0.00", "comissaoaprazo":"0.00", "comissaoquitacao":"0.00", "mes":0, "naopermitirdesconto":0, "horainicialdomingo":"HH:MM:ss", "horafinaldomingo":"HH:MM:ss", "horainicialsegunda":"HH:MM:ss", "horafinalsegunda":"HH:MM:ss", "horainicialterca":"HH:MM:ss", "horafinalterca":"HH:MM:ss", "horainicialquarta":"HH:MM:ss", "horafinalquarta":"HH:MM:ss", "horainicialquinta":"HH:MM:ss", "horafinalquinta":"HH:MM:ss", "horainicialsexta":"HH:MM:ss", "horafinalsexta":"HH:MM:ss", "horainicialsabado":"HH:MM:ss", "horafinalsabado":"HH:MM:ss", "responsavelpromocao":0, "limitepromocao":0, "jsonpromocao":"Texto", "idcategoriacliente":1, "codigopromocaoscanntech":"Texto", "continua":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/promocao

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/promocao/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caracter	9
nome	Nome		Caracter	40
inativo	Identifica se a promoção esta inativa		Inteiro			0 – Não; 1 – Sim.
datainicial	Data inicial
datafinal	Data final
idtabelafinanciamento	ID da tabela de financiamento		Inteiro
comissao	Percentual de comissão		Decimal	5	2
comissaoavista	Comissão à vista		Decimal	5	2
comissaoaprazo	Comissão a prazo		Decimal	5	2
comissaoquitacao	Comissão na quitação		Decimal	5	2
mes	Mês do primeiro pagamento		Inteiro
naopermitirdesconto	Permitir desconto		Inteiro			0 – Não; 1 – Sim.
horainicialdomingo	Hora da inicial domingo
horafinaldomingo	Hora da final domingo
horainicialsegunda	Hora da inicial segunda
horafinalsegunda	Hora da final segunda
horainicialterca	Hora da inicial terça
horafinalterca	Hora da final terça
horainicialquarta	Hora da inicial quarta
horafinalquarta	Hora da final quarta
horainicialquinta	Hora da inicial quinta
horafinalquinta	Hora da final quinta
horainicialsexta	Hora da inicial sexta
horafinalsexta	Hora da final sexta
horainicialsabado	Hora da inicial sábado
horafinalsabado	Hora da final sábado
responsavelpromocao	Responsável		Inteiro			0 – Empresa; 1 – Scanntech; 2 – Cresce Vendas.
limitepromocao	Limite máximo de promoção por cupom		Inteiro
jsonpromocao	Json de retorno da integração		Caractere
idcategoriacliente	ID da Categoria do Cliente		Inteiro
codigopromocaoscanntech	Código da promoção na Scanntech		Caractere	9
continua	Determina se a promoção é continua		Inteiro

58. Endpoint Receita ICMS (v1)

Receita ICMS

URL: “/public-api/v1/commons/receitaicms“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "idestado":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/receitaicms

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/receitaicms/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idestado	ID do estado		Inteiro
codigo	Código		Caractere	8
descricao	Descrição		Caractere	256

60. Endpoint Receita sem contribuição (v1)

Receita sem contribuição

URL: “/public-api/v1/commons/receitasemcontribuicao“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "cst":"Texto", "descricaounidade":"Texto", "ncm":"Texto", "ncmex":"Texto", "exipi":"Texto", "aliquotapis":"0.0000", "aliquotacofins":"0.0000", "datainicial":"yyyy-MM-dd", "datafinal":"yyyy-MM-dd"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/receitasemcontribuicao

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	16
descricao	Descrição		Caractere	1024
cst	CST PIS/COFINS		Caractere	2		01-Operação Tributável com Alíquota Básica, 02-Operação Tributável com Alíquota Diferenciada, 03-Operação Tributável com Alíquota por Unidade de Medida de Produto, 04-Operação Tributável Monofásica – Revenda a Alíquota Zero, 05-Operação Tributável por Substituição Tributária, 06-Operação tributável alíquota zero, 07-Operação isenta da contribuição, 08-Operação sem incidência de contribuição, 09-Operação com suspensão da contribuição, 49-Outras Operações de Saída, 50-Operação com Direito a Crédito – Vinculada Exclusivamente a Receita Tributada no Mercado Interno, 51-Operação com Direito a Crédito – Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno, 52-Operação com Direito a Crédito – Vinculada Exclusivamente a Receita de Exportação, 53-Operação com Direito a Crédito – Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, 54-Operação com Direito a Crédito – Vinculada a Receitas Tributadas no Mercado Interno e de Exportação, 55-Operação com Direito a Crédito – Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação, 56-Operação com Direito a Crédito – Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação, 60-Crédito Presumido – Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno, 61-Crédito Presumido – Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno, 62-Crédito Presumido – Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação, 63-Crédito Presumido – Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, 64-Crédito Presumido – Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação, 65-Crédito Presumido – Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação, 66-Crédito Presumido – Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação, 67-Crédito Presumido – Outras Operações, 70-Operação de Aquisição sem Direito a Crédito, 71-Operação de Aquisição com Isenção, 72-Operação de Aquisição com Suspensão, 73-Operação de Aquisição a Alíquota Zero, 74-Operação de Aquisição sem Incidência da Contribuição, 75-Operação de Aquisição por Substituição Tributária, 98-Outras Operações de Entrada,99-Outras operações.
descricaounidade	Unidade		Caracter	127
ncm	NCM		Caracter	256
ncmex	NCM Ex		Caracter	256
exipi	Ex do IPI		Caracter	256
aliquotapis	Alíquota do PIS		Decimal	12	4
aliquotacofins	Alíquota do COFINS		Decimal	12	4
datainicial	Data inicial
datafinal	Data final

61. Endpoint Região de entidades (v1)

Região de entidades

URL: “/public-api/v1/commons/regiaoentidade“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "valor":"0.00", "codigotaxaentrega":0, "faixasendereco":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/regiaoentidade

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/regiaoentidade/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caracter	15
nome	Nome		Caracter	50
valor	Valor		Decimal	12	2
codigotaxaentrega	Código da taxa de entrega		Inteiro
faixasendereco	Faixas de CEP e UF da região		Caracter

62. Endpoint Sub apuração do ICMS (v1)

Sub apuração do ICMS

URL: “/public-api/v1/commons/subapuracaoicms“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "anomes":"yyyy-MM-dd", "idfilial":1, "saldocredorperiodoanterior":"0.00", "tipoapuracao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/subapuracaoicms

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/subapuracaoicms/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
anomes	Período da apuração
idfilial	ID da filial		Inteiro
saldocredorperiodoanterior	Saldo do período anterior		Decimal	12	2
tipoapuracao	Tipo apuração		Caracter	1		0 – Operação Própria; 1 – Operação por ST; 2 – Outras Apurações; 3 – Apuração 1; 4 – Apuração 2; 5 – Apuração 3; 6 – Apuração 4; 7 – Apuração 5; 8 – Apuração 6; 9 – Informativo.

63. Endpoint Tipos de cobrança (v1)

Tipos de cobrança

URL: “/public-api/v1/commons/tipocobranca“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto", "idtipodocumentofinanceiro":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipocobranca

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipocobranca/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	6
descricao	Descrição		Caractere	50
idtipodocumentofinanceiro			Inteiro

64. Endpoint Tipos de contato (v1)

Tipos de contato

URL: “/public-api/v1/commons/tipocontato“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipocontato

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipocontato/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caracter	16
descricao	Descrição		Caracter	50

65. Endpoint Tipos de entidades da operação fiscal (v1)

Tipos de entidades da operação fiscal

URL: “/public-api/v1/commons/tipoentidadeoperacaofiscal“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "descricao":"Texto"}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
descricao	Descrção		Caracter	256

66. Endpoint Tipos de histórico de contato (v1)

Tipos de histórico de contato

URL: “/public-api/v1/commons/tipohistoricocontato“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipohistoricocontato

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caracter	6
descricao	Descrição		Caracter	50

67. Endpoint Tipos de informações adicionais na apuração (v1)

Tipos de informações adicionais na apuração

URL: “/public-api/v1/commons/tipoinformacaoadicionalapur“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "descricao":"Texto"}

Exemplos

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	8
descricao	Descrição		Caractere	300

68. Endpoint Tipos de pedido (v1)

Tipos de pedido

URL: “/public-api/v1/commons/tipopedido“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "descricao":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipopedido

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/tipopedido/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
descricao	Descrição		Caractere	256

69. Endpoint Unidade de Medidas (v1)

Unidade de medidas

URL: “/public-api/v1/commons/unidademedida“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "tipovalor":0}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/unidademedida

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/unidademedida/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	6
nome	Descrição		Caractere	50
tipovalor	Tipo de valor		Inteiro			0 – Quantidade; 1 – Hora.

70. Endpoint Usuários (v1)

Usuários

URL: “/public-api/v1/commons/usuario“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":"Texto", "nome":"Texto", "inativo":0, "supervisor":0, "email":"Texto", "celular":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/usuario

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/usuario/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Login		Caractere	10
nome	Nome		Caractere	60
inativo	Identifica se o usuário está inativo		Inteiro			0 – Não; 1 – Sim.
.supervisor	Identifica se o usuário é supervisor		Inteiro			0 – Não; 1 – Sim.
email	E-mail		Caractere	50
celular	Celular		Caractere	40

71. Endpoint Valores nutricionais (v1)

Valores nutricionais

URL: “/public-api/v1/commons/valornutricional“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"id":1, "codigo":0, "descricao":"Texto", "valorenergetico":0, "carboidratos":"0.000", "proteina":"0.000", "fibraalimentar":"0.000", "gordurastotais":"0.000", "gordurassaturadas":"0.000", "gordurastrans":"0.000", "sodio":"0.000", "porcao":0, "tipoporcao":0, "porcaoporembalagem":0, "acucarestotais":"0.0", "acucaresadicionados":"0.0", "lactose":"0.0", "galactose":"0.0", "altoemacucaradicionado":0, "altoemgordurasaturada":0, "altoemsodio":0, "medidacaseira":"Texto", "inteiromedidacaseira":0, "decimalmedidacaseira":"Texto", "idrotulonutricional":1}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/valornutricional

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/valornutricional/${id}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Inteiro
descricao	Descrição		Caractere	255
valorenergetico	Valor energético		Inteiro
carboidratos	Carboidratos		Decimal	8	3
proteina	Proteínas		Decimal	8	3
fibraalimentar	Fibra alimentar		Decimal	8	3
gordurastotais	Gorduras totais		Decimal	8	3
gordurassaturadas	Gorduras saturadas		Decimal	8	3
gordurastrans	Gorduras trans		Decimal	8	3
sodio	Sódio		Decimal	8	3
porcao	Informação de porção		Inteiro
tipoporcao	Tipo de porção		Inteiro			0 – Grama; 1 – Mililitro; 2 – Unidade.
porcaoporembalagem	Porção por embalagem		Inteiro
acucarestotais	Açúcares totais		Decimal	3	1
acucaresadicionados	Açúcares adicionados		Decimal	3	1
lactose	Lactose		Decimal	5	1
galactose	Galactose		Decimal	5	1
altoemacucaradicionado	Alto teor de açúcar adicionado		Inteiro			0 – Não; 1 – Sim.
altoemgordurasaturada	Alto teor de gordura saturada		Inteiro			0 – Não; 1 – Sim.
altoemsodio	Alto teor de sódio		Inteiro			0 – Não; 1 – Sim.
medidacaseira	Medida caseira		Caractere	2		00 – Colher de sopa; 01 – Colher de café; 02 – Colher de chá; 03 – Xícara; 04 – De xícara; 05 – Unidade; 06 – Pacote; 07 – Fatia; 08 – Fatia fina; 09 – Pedaço; 10 – Folha; 11 – Pão; 12 – Biscoito; 13 – Bisnaguinha; 14 – Disco; 15 – Copo; 16 – Porção; 17 – Tablete; 18 – Sache; 19 – Almôndega; 20 – Bife; 21 – Filé; 22 – Concha; 23 – Bala; 24 – Prato fundo; 25 – Pitada; 26 – Lata; 27 – Xícara de chá; 28 – Prato raso.
inteiromedidacaseira	Parte inteira da medida caseira		Inteiro
decimalmedidacaseira	Parte decimal da medida caseira		Caractere	2		0 – Inteiro(a); 1 – 1/4; 2 – 1/3; 3 – 1/2; 4 – 2/3; 5 – 3/4.
idrotulonutricional	Imagem do rótulo nutricional		Inteiro