Eprom TI Informática - Api de Integração
API Endpoint
https://open-api.eprom.com.br/apiAPI ¶
Sobre ¶
Api de Integração com o ERP E-Solution desenvolvido por Eprom TI informática
Esta API tem como objetivo permitir a integração deste ERP com softwares de terceiros.
Última atualização: 25/04/2025 11:12:24
Auth ¶
Nesse grupo documentar sobre o processo de autenticação na Open API.
Autenticação ¶
Endpoints relativos ao processo de autenticação na Open API.
POST https://open-api.eprom.com.br/api/Auth/Login
Requests
Headers
Accept: application/json
Content-Type: application/jsonBody
{
"email": "email@dominio.com.br",
"senha": "senha123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Informar o e-mail de login"
},
"senha": {
"type": "string",
"description": "Informar a senha de login"
}
},
"required": [
"email",
"senha"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"access_token": "eyJhbGciOiJI...",
"access_token_expiration": "2024-09-25T09:48:31-03:00",
"refresh_token": "eyJhbGciOiJIUzI...",
"refresh_token_expiration": "2025-09-25T07:48:31-03:00"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Efetuar LoginPOST/Auth/Login
Processo de Login na Open API.
Baixas Financeiro ¶
Nesse grupo iremos trabalhar os endpoints referentes à baixa financeira de documentos.
Pagamentos ¶
Endpoints relativos ao pagamento de títulos do contas a pagar.
POST https://open-api.eprom.com.br/api/Pagamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"baixas": [
{
"id": 1,
"valor": 10
}
],
"data_baixa": "2025-03-10",
"Contas": [
{
"forma_pagto_id": 1,
"cxconta_id": 1,
"valor": 1
}
],
"Cartoes": [
{
"forma_pagto_id": 1,
"cxconta_id": 1,
"valor": 1,
"autenticao": "<texto>",
"historico": "<texto>"
}
],
"Cheques": [
{
"forma_pagto_id": 1,
"valor": 1,
"cheques": [
{
"financeiro_id": 1,
"valor": 1
}
]
}
],
"Haveres": [
{
"forma_pagto_id": 1,
"valor": 1
}
],
"Compensacoes": [
{
"forma_pagto_id": 1,
"valor": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"baixas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID do item do documento para efetuar a baixa"
},
"valor": {
"type": "number",
"description": "Informar o valor referente a baixa"
}
},
"required": [
"id"
]
},
"description": "Conjunto de documentos a serem baixados"
},
"data_baixa": {
"type": "string",
"description": "Informar a data para efetuar a baixa"
},
"Contas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"cxconta_id": {
"type": "number",
"description": "ID da Conta para pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"forma_pagto_id",
"cxconta_id",
"valor"
]
},
"description": "Conjunto de contas referente as baixas"
},
"Cartoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"cxconta_id": {
"type": "number",
"description": "ID da Conta para pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
},
"autenticao": {
"type": "string",
"description": "Texto referente a autenticação"
},
"historico": {
"type": "string",
"description": "histórico"
}
},
"required": [
"forma_pagto_id",
"cxconta_id",
"valor"
]
},
"description": "Conjunto de cartões referente as baixas"
},
"Cheques": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
},
"cheques": {
"type": "array",
"items": {
"type": "object",
"properties": {
"financeiro_id": {
"type": "number",
"description": "ID do financeiro gerado do cheque"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"financeiro_id",
"valor"
]
},
"description": "Conjunto de cheques"
}
},
"required": [
"forma_pagto_id",
"valor",
"cheques"
]
},
"description": "Conjunto de cheques referente as baixas"
},
"Haveres": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"forma_pagto_id",
"valor"
]
},
"description": "Conjunto de haveres referente as baixas"
},
"Compensacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"forma_pagto_id",
"valor"
]
},
"description": "Conjunto de compensações referente as baixas"
}
},
"required": [
"baixas"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Baixa realizada",
"data": [
{
"id": 4035,
"status": "BAIXADO",
"data_vencimento": "2024-10-14",
"parcela": 1,
"valor_pendente": 0,
"valor_baixado": 203,
"valor_total": 203,
"codigo_movimentacao": 1825,
"observacao": null,
"Referencia": {
"id": 7662,
"tipo": "ENTRADA DE MERCADORIA",
"Filial": {
"id": 125,
"nome": "Empresa Teste"
},
"numero": null,
"Fornecedor": {
"id": 430,
"nome": "Fornecedor 1"
},
"data_emissao": "2024-10-14T14:44:01.000Z",
"data_entrada": "2024-10-14"
},
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
},
"Baixas": [
{
"id": 2190,
"valor": 203,
"data_lancamento": "2025-03-12",
"codigo_movimentacao": 1825,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação de um pagamentoPOST/Pagamento
Processo de Criação de um pagamento. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| baixas | ✔️ | TipoPgBaixa[ ] | Conjunto de Documentos a serem baixados. |
| data_baixa | ✔️ | Data | Informar a data da baixa do pagamento. Formato 2024-10-20. |
| Contas | TipoPgConta[ ] | Conjunto de Contas referente a baixa. | |
| Cartoes | TipoPgCartao[ ] | Conjunto de Cartões referente a baixa. | |
| Cheques | TipoPgCheque[ ] | Conjunto de Cheques referente a baixa. | |
| Haveres | TipoPgHaver[ ] | Conjunto de Haveres referente a baixa. | |
| Compensacoes | TipoPgCompensacao[ ] | Conjunto de Compensações referente a baixa. |
Tipos de dados usados:
Tipo dados da Baixa
TipoPgBaixa
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
id
✔️
Inteiro
Id do pendência a ser baixada.
valor
✔️
Decimal(17,6)
Valor a ser baixado.
TipoPgBaixa
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| id | ✔️ | Inteiro | Id do pendência a ser baixada. |
| valor | ✔️ | Decimal(17,6) | Valor a ser baixado. |
Tipo de dados da Conta
TipoPgConta
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
cxconta_id
✔️
Inteiro
Id da conta que será lançado.
valor
✔️
Decimal(17,6)
Valor pago.
TipoPgConta
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| cxconta_id | ✔️ | Inteiro | Id da conta que será lançado. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados do cartão
TipoPgCartao
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
cxconta_id
✔️
Inteiro
Id da conta que será lançado.
valor
✔️
Decimal(17,6)
Valor pago.
autenticao
Texto
Texto referente a autenticação.
historico
Texto
Texto referente ao histórico.
TipoPgCartao
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| cxconta_id | ✔️ | Inteiro | Id da conta que será lançado. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
| autenticao | Texto | Texto referente a autenticação. | |
| historico | Texto | Texto referente ao histórico. |
Tipo de dados para Cheques
TipoPgCheque
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
cheques
✔️
TipoPgChequeDados[ ]
Conjunto de cheques.
valor
✔️
Decimal(17,6)
Valor pago.
TipoPgCheque
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| cheques | ✔️ | TipoPgChequeDados[ ] | Conjunto de cheques. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados para Haveres
TipoPgHaver
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
valor
✔️
Decimal(17,6)
Valor pago.
TipoPgHaver
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados para Compensações
TipoPgCompensacao
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
valor
✔️
Decimal(17,6)
Valor pago.
TipoPgCompensacao
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados para os cheques
TipoPgChequeDados
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
financeiro_id
✔️
Inteiro
Id da financeiro gerado do cheque.
valor
✔️
Decimal(17,6)
Valor pago.
TipoPgChequeDados
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| financeiro_id | ✔️ | Inteiro | Id da financeiro gerado do cheque. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
GET https://open-api.eprom.com.br/api/Pagamento?id=123&numero=1332&data_emissao=1332&status=PENDENTE&tipo=IMPOSTO&entidade_id=1332&filial_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 2,
"data": [
{
"id": 82,
"status": "BAIXADO",
"data_vencimento": "2021-10-10",
"parcela": 1,
"valor_pendente": 0,
"valor_baixado": 131.75,
"valor_total": 131.75,
"codigo_movimentacao": 879,
"observacao": "teste",
"Referencia": {
"id": 100,
"tipo": "NOTA FISCAL ELETRONICA DE ENTRADA (NF-e)",
"Filial": {
"id": 125,
"nome": "Empresa Teste"
},
"numero": 0,
"Fornecedor": {
"id": 12,
"nome": "Fornecedor X"
},
"data_emissao": "2019-08-12T21:00:00.000Z",
"data_entrada": "2019-08-13"
},
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
},
"Baixas": [
{
"id": 787,
"valor": 131.75,
"data_lancamento": "2021-12-02",
"codigo_movimentacao": 879,
"FormaPagamento": {
"id": 6,
"descricao": "COMPOSICAO"
}
}
]
},
{
"id": 83,
"status": "BAIXADO",
"data_vencimento": "2021-10-10",
"parcela": 1,
"valor_pendente": 0,
"valor_baixado": 15.5,
"valor_total": 15.5,
"codigo_movimentacao": 1360,
"observacao": "teste",
"Referencia": {
"id": 107,
"tipo": "IMPOSTO",
"Filial": {
"id": 125,
"nome": "Empresa Teste"
},
"numero": 0,
"Fornecedor": {
"id": 14,
"nome": "Fornecedor Y"
},
"data_emissao": "2019-08-12T21:00:00.000Z",
"data_entrada": "2019-08-13"
},
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
},
"Baixas": [
{
"id": 1417,
"valor": 15.5,
"data_lancamento": "2023-05-02",
"codigo_movimentacao": 1360,
"FormaPagamento": {
"id": 104,
"descricao": "DEBITO EM CONTA"
}
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar PagamentoGET/Pagamento{?id,numero,data_emissao,status,tipo,entidade_id,filial_id,page,size}
Lista Pagamentos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a despesa pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 1332Número do documento a ser pesquisado ou parte do número. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTEBAIXADO- tipo
string(optional) Example: IMPOSTOTipos de despesas. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
IMPOSTODESPESANF- entidade_id
number(optional) Example: 1332ID da Entidade da despesa. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
string(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
DELETE https://open-api.eprom.com.br/api/Pagamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Estorno PagamentoDELETE/Pagamento/{id}
Processo de estorno de pagamento.
URI Parameters
- id
number(required) Example: 123Id do pagamento
Recebimento ¶
Endpoints relativos ao recebimento de títulos do contas a pagar.
POST https://open-api.eprom.com.br/api/Recebimento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"baixas": [
{
"id": 1,
"valor": 10
}
],
"data_baixa": "2025-03-10",
"Contas": [
{
"forma_pagto_id": 1,
"cxconta_id": 1,
"valor": 1
}
],
"Cartoes": [
{
"forma_pagto_id": 1,
"cxconta_id": 1,
"valor": 1,
"autenticao": "<texto>",
"historico": "<texto>"
}
],
"Cheques": [
{
"forma_pagto_id": 1,
"valor": 1,
"cheques": [
{
"agencia": "<texto>",
"banco_id": 1,
"banda": "<texto>",
"cheque": "<texto>",
"cidade": "<texto>",
"conta": "<texto>",
"dtemissao": "<texto>",
"dtvenc": "<texto>",
"forma_pagto_id": 1,
"nome": "<texto>",
"numdoc": "<texto>",
"observacao": "<texto>",
"tipo_documento_id": 1,
"valor": 1
}
]
}
],
"Haveres": [
{
"forma_pagto_id": 1,
"valor": 1
}
],
"Compensacoes": [
{
"forma_pagto_id": 1,
"valor": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"baixas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID do item do documento para efetuar a baixa"
},
"valor": {
"type": "number",
"description": "Informar o valor referente a baixa"
}
},
"required": [
"id"
]
},
"description": "Conjunto de documentos a serem baixados"
},
"data_baixa": {
"type": "string",
"description": "Informar a data para efetuar a baixa"
},
"Contas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"cxconta_id": {
"type": "number",
"description": "ID da Conta para pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"forma_pagto_id",
"cxconta_id",
"valor"
]
},
"description": "Conjunto de contas referente as baixas"
},
"Cartoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"cxconta_id": {
"type": "number",
"description": "ID da Conta para pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
},
"autenticao": {
"type": "string",
"description": "Texto referente a autenticação"
},
"historico": {
"type": "string",
"description": "histórico"
}
},
"required": [
"forma_pagto_id",
"cxconta_id",
"valor"
]
},
"description": "Conjunto de cartões referente as baixas"
},
"Cheques": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
},
"cheques": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agencia": {
"type": "string",
"description": "Agência do cheque"
},
"banco_id": {
"type": "number",
"description": "ID do banco do cheque"
},
"banda": {
"type": "string",
"description": "Banda do cheque"
},
"cheque": {
"type": "string",
"description": "Numero do cheque"
},
"cidade": {
"type": "string",
"description": "Cidade do cheque"
},
"conta": {
"type": "string",
"description": "Conta do cheque"
},
"dtemissao": {
"type": "string",
"description": "Data de Emissão do cheque"
},
"dtvenc": {
"type": "string",
"description": "Data de vencimento do cheque"
},
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento do cheque"
},
"nome": {
"type": "string",
"description": "Nome do emissor do cheque"
},
"numdoc": {
"type": "string",
"description": "Número do documento do emissor do cheque"
},
"observacao": {
"type": "string",
"description": "Observação do cheque"
},
"tipo_documento_id": {
"type": "number",
"description": "ID do tipo do documento do cheque"
},
"valor": {
"type": "number",
"description": "Valor pago"
}
},
"required": [
"agencia",
"banco_id",
"banda",
"cheque",
"cidade",
"conta",
"dtemissao",
"dtvenc",
"forma_pagto_id",
"nome",
"numdoc",
"observacao",
"tipo_documento_id",
"valor"
]
},
"description": "Conjunto de cheques"
}
},
"required": [
"forma_pagto_id",
"valor",
"cheques"
]
},
"description": "Conjunto de cheques referente as baixas"
},
"Haveres": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"forma_pagto_id",
"valor"
]
},
"description": "Conjunto de haveres referente as baixas"
},
"Compensacoes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento"
},
"valor": {
"type": "number",
"description": "Valor para pagamento"
}
},
"required": [
"forma_pagto_id",
"valor"
]
},
"description": "Conjunto de compensações referente as baixas"
}
},
"required": [
"baixas"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Baixa realizada",
"data": [
{
"id": 4035,
"status": "BAIXADO",
"data_vencimento": "2024-10-14",
"parcela": 1,
"valor_pendente": 0,
"valor_baixado": 203,
"valor_total": 203,
"codigo_movimentacao": 1825,
"observacao": null,
"Referencia": {
"id": 7662,
"tipo": "ENTRADA DE MERCADORIA",
"Filial": {
"id": 125,
"nome": "Empresa Teste"
},
"numero": null,
"Fornecedor": {
"id": 430,
"nome": "Fornecedor 1"
},
"data_emissao": "2024-10-14T14:44:01.000Z",
"data_entrada": "2024-10-14"
},
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
},
"Baixas": [
{
"id": 2190,
"valor": 203,
"data_lancamento": "2025-03-12",
"codigo_movimentacao": 1825,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação de um RecebimentoPOST/Recebimento
Processo de Criação de um Recebimento. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| baixas | ✔️ | TipoRecBaixa[ ] | Conjunto de Documentos a serem baixados. |
| data_baixa | ✔️ | Data | Informar a data da baixa do recebimento. Formato 2024-10-20. |
| Contas | TipoRecConta[ ] | Conjunto de Contas referente a baixa. | |
| Cartoes | TipoRecCartao[ ] | Conjunto de Cartões referente a baixa. | |
| Cheques | TipoRecCheque[ ] | Conjunto de Cheques referente a baixa. | |
| Haveres | TipoRecHaver[ ] | Conjunto de Haveres referente a baixa. | |
| Compensacoes | TipoRecCompensacao[ ] | Conjunto de Compensações referente a baixa. |
Tipos de dados usados:
Tipo dados da Baixa
TipoRecBaixa
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
id
✔️
Inteiro
Id do pendência a ser baixada.
valor
✔️
Decimal(17,6)
Valor a ser baixado.
TipoRecBaixa
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| id | ✔️ | Inteiro | Id do pendência a ser baixada. |
| valor | ✔️ | Decimal(17,6) | Valor a ser baixado. |
Tipo de dados da Conta
TipoRecConta
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
cxconta_id
✔️
Inteiro
Id da conta que será lançado.
valor
✔️
Decimal(17,6)
Valor pago.
TipoRecConta
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| cxconta_id | ✔️ | Inteiro | Id da conta que será lançado. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados do cartão
TipoRecCartao
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
cxconta_id
✔️
Inteiro
Id da conta que será lançado.
valor
✔️
Decimal(17,6)
Valor pago.
autenticao
Texto
Texto referente a autenticação.
historico
Texto
Texto referente ao histórico.
TipoRecCartao
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| cxconta_id | ✔️ | Inteiro | Id da conta que será lançado. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
| autenticao | Texto | Texto referente a autenticação. | |
| historico | Texto | Texto referente ao histórico. |
Tipo de dados para Cheques
TipoRecCheque
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
cheques
✔️
TipoRecChequeDados[ ]
Conjunto de cheques.
valor
✔️
Decimal(17,6)
Valor pago.
TipoRecCheque
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| cheques | ✔️ | TipoRecChequeDados[ ] | Conjunto de cheques. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados para Haveres
TipoRecHaver
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
valor
✔️
Decimal(17,6)
Valor pago.
TipoRecHaver
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados para Compensações
TipoRecCompensacao
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
forma_pagto_id
✔️
Inteiro
Id da forma de pagamento.
valor
✔️
Decimal(17,6)
Valor pago.
TipoRecCompensacao
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| forma_pagto_id | ✔️ | Inteiro | Id da forma de pagamento. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
Tipo de dados para os cheques
TipoRecChequeDados
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
agencia
✔️
Texto
Agência do cheque.
banco_id
✔️
Inteiro
ID do banco do cheque.
banda
✔️
Texto
Banda do cheque.
cheque
✔️
Texto
Numero do cheque.
cidade
✔️
Texto
Cidade do cheque.
conta
✔️
Texto
Conta do cheque.
dtemissao
✔️
Texto
Data de Emissão do cheque.
dtvenc
✔️
Texto
Data de vencimento do cheque.
forma_pagto_id
✔️
Inteiro
ID da forma de pagamento do cheque.
nome
✔️
Texto
Nome do emissor do cheque.
numdoc
✔️
Texto
Número do documento do emissor do cheque.
observacao
✔️
Texto
Observação do cheque.
tipo_documento_id
✔️
Inteiro
ID do tipo do documento do cheque.
valor
✔️
Decimal(17,6)
Valor pago.
TipoRecChequeDados
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| agencia | ✔️ | Texto | Agência do cheque. |
| banco_id | ✔️ | Inteiro | ID do banco do cheque. |
| banda | ✔️ | Texto | Banda do cheque. |
| cheque | ✔️ | Texto | Numero do cheque. |
| cidade | ✔️ | Texto | Cidade do cheque. |
| conta | ✔️ | Texto | Conta do cheque. |
| dtemissao | ✔️ | Texto | Data de Emissão do cheque. |
| dtvenc | ✔️ | Texto | Data de vencimento do cheque. |
| forma_pagto_id | ✔️ | Inteiro | ID da forma de pagamento do cheque. |
| nome | ✔️ | Texto | Nome do emissor do cheque. |
| numdoc | ✔️ | Texto | Número do documento do emissor do cheque. |
| observacao | ✔️ | Texto | Observação do cheque. |
| tipo_documento_id | ✔️ | Inteiro | ID do tipo do documento do cheque. |
| valor | ✔️ | Decimal(17,6) | Valor pago. |
GET https://open-api.eprom.com.br/api/Recebimento?id=123&numero=1332&data_vencimento=2025-01-01,2025-01-31&status=PENDENTE&codigo_movimentacao=1&cliente_id=1332&filial_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 741,
"data": [
{
"id": 61,
"status": "BAIXADO",
"data_vencimento": "2019-03-21",
"parcela": 1,
"valor_pendente": 0,
"valor_baixado": 29,
"valor_total": 29,
"codigo_movimentacao": 1256,
"observacao": null,
"Referencia": {
"id": 10,
"tipo": "CF-e",
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"numero": 2,
"Cliente": {
"id": null,
"nome": null
},
"data_emissao": "2019-02-18T21:00:00.000Z",
"data_entrada": null
},
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
},
"Baixas": [
{
"id": 1173,
"valor": 29,
"data_lancamento": "2022-12-27",
"codigo_movimentacao": 1256,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
},
{
"id": 64,
"status": "BAIXADO",
"data_vencimento": "2019-01-03",
"parcela": 1,
"valor_pendente": 0,
"valor_baixado": 2044.32,
"valor_total": 2044.32,
"codigo_movimentacao": null,
"observacao": null,
"Referencia": {
"id": 35,
"tipo": "NOTA FISCAL",
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"numero": 1785,
"Cliente": {
"id": 12,
"nome": "Cley Embalagem Eng Conexoes"
},
"data_emissao": "2018-12-27T21:00:00.000Z",
"data_entrada": null
},
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
},
"Baixas": [
{
"id": 307,
"valor": 2044.32,
"data_lancamento": "2021-09-30",
"codigo_movimentacao": 498,
"FormaPagamento": {
"id": 7,
"descricao": "CARTAO DE CREDITO"
}
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar RecebimentoGET/Recebimento{?id,numero,data_vencimento,status,codigo_movimentacao,cliente_id,filial_id,page,size}
Lista Recebimentos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a despesa pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_vencimento
string(optional) Example: 2025-01-01,2025-01-31Data de vencimento do recebimento. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTEBAIXADO- codigo_movimentacao
number(optional) Example: 1ID da movimentacao.
- cliente_id
number(optional) Example: 1332ID da Entidade da despesa. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
string(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
DELETE https://open-api.eprom.com.br/api/Recebimento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Estorno RecebimentoDELETE/Recebimento/{id}
Processo de estorno de recebimento.
URI Parameters
- id
number(required) Example: 123Id do recebimento a ser estornado.
Documentos - Despesas ¶
Nesse grupo iremos trabalhar os documentos referentes a despesas.
Despesas ¶
Endpoints relativos ao cadastro de uma despesa.
POST https://open-api.eprom.com.br/api/Despesa
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"tipo": "IMPOSTO",
"numero": 123,
"data_emissao": "2024-10-25 11:52:56",
"observacao": "Observação",
"filial_id": 1,
"entidade_id": 2,
"Itens": [
{
"descricao": "descrição item",
"quantidade": 10,
"valor_unitario": 15.63,
"desconto": 14.63,
"planoconta_id": 1,
"centrocusto_id": 1,
"aplicacao_id": 1,
"frota_id": 1
}
],
"Pagamentos": [
{
"parcela": 1,
"vencimento": "2024-10-25",
"valor": 15,
"forma_pagto_id": 2,
"observacao": "obs"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"tipo": {
"type": "string",
"enum": [
"IMPOSTO",
"DESPESA",
"NF"
],
"description": "Tipo da Despesa"
},
"numero": {
"type": "number",
"description": "Número da despesa"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão da despesa"
},
"observacao": {
"type": "string",
"description": "Observação da despesa"
},
"filial_id": {
"type": "number",
"description": "ID da Filial da Despesa"
},
"entidade_id": {
"type": "number",
"description": "ID da Entidade da Despesa"
},
"Itens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do item da Despesa"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item da Despesa"
},
"valor_unitario": {
"type": "number",
"description": "Valor do item da Despesa"
},
"desconto": {
"type": "number",
"description": "Valor do desconto do item da Despesa"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item da Despesa"
},
"centrocusto_id": {
"type": "number",
"description": "ID do centro de custo do item da Despesa"
},
"aplicacao_id": {
"type": "number",
"description": "ID da aplicação do item da Despesa"
},
"frota_id": {
"type": "number",
"description": "ID da frota do item da Despesa"
}
}
},
"description": "Itens da Despesa"
},
"Pagamentos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parcela": {
"type": "number",
"description": "Número da parcela."
},
"vencimento": {
"type": "string",
"description": "Data de vencimento."
},
"valor": {
"type": "number",
"description": "Valor da parcela."
},
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento da parcela."
},
"observacao": {
"type": "string",
"description": "Observação da parcela"
}
}
},
"description": "Parcelas da despesa"
}
},
"required": [
"tipo",
"entidade_id",
"Itens",
"Pagamentos"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 377121,
"numero": 1234,
"data_emissao": "2024-10-28T12:24:29.000Z",
"status": "PENDENTE",
"tipo": "IMPOSTO",
"Entidade": {
"id": 1,
"nome": "DOGIS COMERCIO E IMPORTACAO DE PRODUTOS DE USO DOMESTIC LTDA"
},
"Filial": {
"id": 1,
"nome": "DOGIS COMERCIO E IMPORTACAO DE PRODUTOS DE USO DOMESTIC LTDA"
},
"Itens": [
{
"id": 971491,
"sequencia": 1,
"descricao": "Despesa de Teste 01",
"quantidade": 1,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
},
{
"id": 971492,
"sequencia": 2,
"descricao": "Despesa de Teste 02",
"quantidade": 5,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 251760,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 251761,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação de uma DespesaPOST/Despesa
Processo de Criação de uma Despesa. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| tipo | ✔️ | TipoDocDespesa | Tipo Documento de Despesa. Os valores possíveis para esse campo são: |
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão da despesa. Formato 2024-10-20 23:53:51. | |
| observacao | Texto | Informar a Observação da despesa. | |
| filial_id | Inteiro | Informar o ID da Filial da Despesa. | |
| entidade_id | ✔️ | Inteiro | Informar o ID da entidade referete a despesa. |
| Itens | ✔️ | TipoDocDespItem[ ] | Conjunto de Itens da despesa. |
| Pagamentos | ✔️ | TipoDocDespPag[ ] | Conjunto de dados referente ao Pagamento da despesa. |
Tipos de dados usados:
Tipo de Desepesas
TipoDocDespesa
-
DESPESA
-
IMPOSTO
-
NF
TipoDocDespesa
-
DESPESA -
IMPOSTO -
NF
Itens de uma Despesa
TipoDocDespItem
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
descricao
Texto
Descrição da item da despesa.
quantidade
Decimal(17,6)
Quantidade do item da despesa.
valor_unitario
Decimal(17,6)
Valor Unitário do item da despesa.
desconto
Decimal(17,6)
Valor Desconto do item da despesa.
planoconta_id
Inteiro
ID do plano de contas do item da despesa.
centrocusto_id
Inteiro
ID do centro de custo do item da despesa.
aplicacao_id
Inteiro
ID da aplicação do item da despesa.
frota_id
Inteiro
ID da frota do item da despesa.
TipoDocDespItem
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| descricao | Texto | Descrição da item da despesa. | |
| quantidade | Decimal(17,6) | Quantidade do item da despesa. | |
| valor_unitario | Decimal(17,6) | Valor Unitário do item da despesa. | |
| desconto | Decimal(17,6) | Valor Desconto do item da despesa. | |
| planoconta_id | Inteiro | ID do plano de contas do item da despesa. | |
| centrocusto_id | Inteiro | ID do centro de custo do item da despesa. | |
| aplicacao_id | Inteiro | ID da aplicação do item da despesa. | |
| frota_id | Inteiro | ID da frota do item da despesa. |
Itens de um pagamento de Despesa
TipoDocDespPag
Os campos que compõem uma parcela de um pagamento de uma despesa são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
parcela
Inteiro
Informar o número da parcela.
vencimento
Data
Informar a data de vencimento da parcela.
valor
Decimal(15,2)
Informar o valor da parcela.
forma_pagto_id
Inteiro
Informar o ID da forma de pagamento da parcela.
observacao
String(50)
Informar a observação da parcela.
TipoDocDespPag
Os campos que compõem uma parcela de um pagamento de uma despesa são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Informar o número da parcela. | |
| vencimento | Data | Informar a data de vencimento da parcela. | |
| valor | Decimal(15,2) | Informar o valor da parcela. | |
| forma_pagto_id | Inteiro | Informar o ID da forma de pagamento da parcela. | |
| observacao | String(50) | Informar a observação da parcela. |
GET https://open-api.eprom.com.br/api/Despesa?id=123&numero=1332&data_emissao=1332&status=PENDENTE&tipo=IMPOSTO&entidade_id=1332&filial_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 52,
"data": [
{
"id": 266,
"numero": 123456789,
"data_emissao": "2020-03-09T00:00:00.000Z",
"status": "CONCLUIDO",
"tipo": "DESPESA",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 501,
"sequencia": 1,
"descricao": "DESPESAS DO TIPO X",
"quantidade": 1,
"valor_unitario": 200,
"desconto": 0,
"PlanoConta": {
"id": 357,
"conta": "3.01.01.07.02.02.00",
"descricao": "Ordenados, Salários, Gratificações E Outras Remunerações A Empregados"
},
"CentroCusto": {
"id": 2,
"codigo": "2",
"descricao": "COMERCIAL"
},
"Aplicacao": null,
"Frota": null
},
{
"id": 9202,
"sequencia": 2,
"descricao": "DESPESAS DO TIPO Y",
"quantidade": 1,
"valor_unitario": 200,
"desconto": 0,
"PlanoConta": {
"id": 357,
"conta": "3.01.01.07.02.02.00",
"descricao": "Ordenados, Salários, Gratificações E Outras Remunerações A Empregados"
},
"CentroCusto": {
"id": 2,
"codigo": "2",
"descricao": "COMERCIAL"
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 164,
"parcela": 1,
"vencimento": "2020-03-12",
"valor": 200,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
},
{
"id": 633,
"numero": 0,
"data_emissao": "2020-07-02T15:27:33.000Z",
"status": "CONCLUIDO",
"tipo": "NF",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 1101,
"sequencia": 1,
"descricao": "DESPESA A",
"quantidade": 0,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 832,
"conta": "3.01.01.09.01.99.03",
"descricao": "Aluguel"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
},
{
"id": 1102,
"sequencia": 2,
"descricao": "DESPESA B",
"quantidade": 0,
"valor_unitario": 135,
"desconto": 0,
"PlanoConta": {
"id": 833,
"conta": "3.01.01.07.01.03.01",
"descricao": "Seguro De Vida"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
},
{
"id": 1103,
"sequencia": 3,
"descricao": "DESPESA C",
"quantidade": 0,
"valor_unitario": 80,
"desconto": 0,
"PlanoConta": {
"id": 813,
"conta": "3.01.01.07.06.33.02",
"descricao": "Consórcios"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 300,
"parcela": 1,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 301,
"parcela": 2,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 302,
"parcela": 3,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
},
{
"id": 1196,
"numero": 0,
"data_emissao": "2020-10-26T20:30:52.000Z",
"status": "CONCLUIDO",
"tipo": "DESPESA",
"Entidade": {
"id": 28,
"nome": "Adrea Rago Carmelo"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 1670,
"sequencia": 1,
"descricao": "teste",
"quantidade": 0,
"valor_unitario": 150,
"desconto": 0,
"PlanoConta": {
"id": 853,
"conta": "1.01.01.05.03",
"descricao": "Aplicações Financeiras"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 733,
"parcela": 1,
"vencimento": "2020-10-26",
"valor": 150,
"observacao": "fererereereer\r\n",
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
}
}
]
},
{
"id": 2156,
"numero": 0,
"data_emissao": "2020-12-17T14:11:09.000Z",
"status": "PENDENTE",
"tipo": "NF",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 2785,
"sequencia": 1,
"descricao": "CANETA BIC",
"quantidade": 1,
"valor_unitario": 129,
"desconto": 0,
"PlanoConta": null,
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
},
{
"id": 2786,
"sequencia": 2,
"descricao": "PASTA ARQUIVO DE PLASTICO AMARELA",
"quantidade": 1,
"valor_unitario": 1.3,
"desconto": 0,
"PlanoConta": null,
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 831,
"parcela": 1,
"vencimento": "2020-12-20",
"valor": 130.3,
"observacao": null,
"FormaPagamento": {
"id": 70,
"descricao": " TEST"
}
}
]
},
{
"id": 2459,
"numero": 0,
"data_emissao": "2021-04-08T10:11:18.000Z",
"status": "CONCLUIDO",
"tipo": "NF",
"Entidade": {
"id": 66,
"nome": "Cantagalli Piabeta Bronca"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 3800,
"sequencia": 1,
"descricao": "REGUA 30 CM TRIDENT SALVE O TRICOLOR PAULISTA AMADO CLUBE BRASILEIRO, TU ÉS FORTE TU ÉS GRANDE APESAR DE ESTAR UM BOM TEMPO SEM TÍTULO",
"quantidade": 100,
"valor_unitario": 11.65,
"desconto": 0,
"PlanoConta": null,
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 969,
"parcela": 1,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 970,
"parcela": 2,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
]
},
{
"id": 2609,
"numero": 0,
"data_emissao": "2021-05-28T16:22:25.000Z",
"status": "PENDENTE",
"tipo": "DESPESA",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 3929,
"sequencia": 1,
"descricao": "TESTE DE DESPESAS",
"quantidade": 1,
"valor_unitario": 1500,
"desconto": 0,
"PlanoConta": {
"id": 870,
"conta": "1.01.01.11.04",
"descricao": "B.brasil - Empréstimos Toyota"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 1044,
"parcela": 1,
"vencimento": "2021-05-28",
"valor": 900,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1045,
"parcela": 2,
"vencimento": "2021-06-28",
"valor": 450,
"observacao": null,
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
},
{
"id": 1046,
"parcela": 3,
"vencimento": "2021-07-28",
"valor": 150,
"observacao": null,
"FormaPagamento": {
"id": 73,
"descricao": "COBRANÇA SANTANDER CNAB 400"
}
}
]
},
{
"id": 2780,
"numero": 0,
"data_emissao": "2021-06-25T08:28:43.000Z",
"status": "CONCLUIDO",
"tipo": "DESPESA",
"Entidade": {
"id": 30,
"nome": "Eyank Amyris Eram"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 4062,
"sequencia": 1,
"descricao": "DESPESAS DE COMBUSTIVEL",
"quantidade": 1,
"valor_unitario": 1460,
"desconto": 0,
"PlanoConta": {
"id": 855,
"conta": "3.01.01.07.05.19.01",
"descricao": "Combustivel"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 1142,
"parcela": 1,
"vencimento": "2021-06-25",
"valor": 1460,
"observacao": null,
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
}
}
]
},
{
"id": 2791,
"numero": 0,
"data_emissao": "2021-07-08T09:59:34.000Z",
"status": "CONCLUIDO",
"tipo": "DESPESA",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 4079,
"sequencia": 1,
"descricao": null,
"quantidade": 1,
"valor_unitario": 500,
"desconto": 0,
"PlanoConta": {
"id": 281,
"conta": "3.01.01.01.03.03.00",
"descricao": "(-) Cofins"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
},
{
"id": 4080,
"sequencia": 2,
"descricao": null,
"quantidade": 1,
"valor_unitario": 1500,
"desconto": 0,
"PlanoConta": {
"id": 282,
"conta": "3.01.01.01.03.04.00",
"descricao": "(-) Pis/pasep"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 1178,
"parcela": 1,
"vencimento": "2021-07-07",
"valor": 500,
"observacao": "sssss\r\n",
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
},
{
"id": 1179,
"parcela": 2,
"vencimento": "2021-07-07",
"valor": 1500,
"observacao": "ssss\r\n",
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
}
]
},
{
"id": 2792,
"numero": 0,
"data_emissao": "2021-07-08T10:23:52.000Z",
"status": "PENDENTE",
"tipo": "DESPESA",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 4081,
"sequencia": 1,
"descricao": null,
"quantidade": 1,
"valor_unitario": 826.14,
"desconto": 0,
"PlanoConta": {
"id": 289,
"conta": "3.01.01.03.01.02.00",
"descricao": "Compras De Insumos À Vista"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
},
{
"id": 4082,
"sequencia": 2,
"descricao": null,
"quantidade": 1,
"valor_unitario": 1821.56,
"desconto": 0,
"PlanoConta": {
"id": 289,
"conta": "3.01.01.03.01.02.00",
"descricao": "Compras De Insumos À Vista"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 1180,
"parcela": 1,
"vencimento": "2021-07-07",
"valor": 0,
"observacao": "teste 1\r\n",
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1181,
"parcela": 2,
"vencimento": "2021-07-07",
"valor": 0,
"observacao": "teste 2\r\n",
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
]
},
{
"id": 3046,
"numero": null,
"data_emissao": "2021-08-04T00:00:00.000Z",
"status": "PENDENTE",
"tipo": "DESPESA",
"Entidade": {
"id": 14,
"nome": "S&d Cegas Devi"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Itens": [
{
"id": 4455,
"sequencia": 1,
"descricao": "teste de descrição da despesa",
"quantidade": 1,
"valor_unitario": 1000,
"desconto": 0,
"PlanoConta": {
"id": 815,
"conta": "3.01.01.07.06.33.04",
"descricao": "Software"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
},
{
"id": 4456,
"sequencia": 2,
"descricao": "teste 2 de lançamento de despesa",
"quantidade": 1,
"valor_unitario": 1500,
"desconto": 0,
"PlanoConta": {
"id": 832,
"conta": "3.01.01.09.01.99.03",
"descricao": "Aluguel"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 1224,
"parcela": 1,
"vencimento": "2021-09-03",
"valor": 2500,
"observacao": "teste de observação da pendência",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar DespesasGET/Despesa{?id,numero,data_emissao,status,tipo,entidade_id,filial_id,page,size}
Lista Despesas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a despesa pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 1332Número do documento a ser pesquisado ou parte do número. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTEEXPEDICAOPARALISADOCONCLUIDOFINALIZADOCANCELADO- tipo
string(optional) Example: IMPOSTOTipos de despesas. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
IMPOSTODESPESANF- entidade_id
number(optional) Example: 1332ID da Entidade da despesa. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
string(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Despesa/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"tipo": "IMPOSTO",
"numero": 12356,
"data_emissao": "2024-10-25 11:52:56",
"observacao": "Observação de teste",
"filial_id": 125,
"entidade_id": 125
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"tipo": {
"type": "string",
"enum": [
"IMPOSTO",
"DESPESA",
"NF"
],
"description": "Tipo da Despesa"
},
"numero": {
"type": "number",
"description": "Número da despesa"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão da despesa"
},
"observacao": {
"type": "string",
"description": "Observação da despesa"
},
"filial_id": {
"type": "number",
"description": "ID da Filial da Despesa"
},
"entidade_id": {
"type": "number",
"description": "ID da Entidade da Despesa"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 377121,
"numero": 123456,
"data_emissao": "2024-10-28T12:24:29.000Z",
"status": "PENDENTE",
"tipo": "IMPOSTO",
"Entidade": {
"id": 1,
"nome": "DOGIS COMERCIO E IMPORTACAO DE PRODUTOS DE USO DOMESTIC LTDA"
},
"Filial": {
"id": 1,
"nome": "DOGIS COMERCIO E IMPORTACAO DE PRODUTOS DE USO DOMESTIC LTDA"
},
"Itens": [
{
"id": 971491,
"sequencia": 1,
"descricao": "Despesa de Teste 01",
"quantidade": 1,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
},
{
"id": 971492,
"sequencia": 2,
"descricao": "Despesa de Teste 02",
"quantidade": 5,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": null,
"Aplicacao": null,
"Frota": null
}
],
"Pagamentos": [
{
"id": 251760,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 251761,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração DespesaPUT/Despesa/{id}
Processo de Alteração de uma Despesa.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| tipo | TipoDocDespesa | Tipo Documento de Despesa. Os valores possíveis para esse campo são: |
|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão da despesa. Formato 2024-10-20 23:53:51. | |
| observacao | Texto | Informar a Observação da despesa. | |
| filial_id | Inteiro | Informar o ID da Filial da Despesa. | |
| entidade_id | Inteiro | Informar o ID da entidade referete a despesa. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Despesa
DELETE https://open-api.eprom.com.br/api/Despesa/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Documento excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão DespesaDELETE/Despesa/{id}
Processo de Exclusão da Despesa.
URI Parameters
- id
number(required) Example: 123Id da Despesa
Despesas Itens ¶
Endpoints relativos ao cadastro de uma despesa.
POST https://open-api.eprom.com.br/api/Despesa/Item
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11693,
"sequencia": 3,
"descricao": "Despesa de Teste 04",
"quantidade": 10,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": {
"id": 2,
"descricao": "veiculo x"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Item DespesaPOST/Despesa/Item
Processo de Criação de um item de uma Despesa. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID da Despesa. |
| descricao | ✔️ | Texto | Descrição da item da despesa. |
| quantidade | Decimal(17,6) | Quantidade do item da despesa. | |
| valor_unitario | Decimal(17,6) | Valor Unitário do item da despesa. | |
| desconto | Decimal(17,6) | Valor Desconto do item da despesa. | |
| planoconta_id | Inteiro | ID do plano de contas do item da despesa. | |
| centrocusto_id | Inteiro | ID do centro de custo do item da despesa. | |
| aplicacao_id | Inteiro | ID da aplicação do item da despesa. | |
| frota_id | Inteiro | ID da frota do item da despesa. |
GET https://open-api.eprom.com.br/api/Despesa/Item?id=123&documento_id=1332&planoconta_id=1332&descricao=1332&valor_unitario=15.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 71,
"data": [
{
"id": 9253,
"sequencia": 1,
"descricao": "Teste",
"quantidade": 2,
"valor_unitario": 50,
"desconto": 0,
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": {
"id": 5,
"descricao": "projeto 10/10"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
},
{
"id": 10988,
"sequencia": 1,
"descricao": "FFFF",
"quantidade": 1,
"valor_unitario": 8000,
"desconto": 0,
"PlanoConta": {
"id": 282,
"conta": "3.01.01.01.03.04.00",
"descricao": "(-) Pis/pasep"
},
"CentroCusto": {
"id": 2,
"codigo": "2",
"descricao": "COMERCIAL"
},
"Aplicacao": null,
"Frota": null
},
{
"id": 10986,
"sequencia": 1,
"descricao": "Xxxx",
"quantidade": 1,
"valor_unitario": 8000,
"desconto": 0,
"PlanoConta": {
"id": 282,
"conta": "3.01.01.01.03.04.00",
"descricao": "(-) Pis/pasep"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": null,
"Frota": null
},
{
"id": 10985,
"sequencia": 1,
"descricao": "teste",
"quantidade": 1,
"valor_unitario": 5000,
"desconto": 0,
"PlanoConta": {
"id": 281,
"conta": "3.01.01.01.03.03.00",
"descricao": "(-) Cofins"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": null,
"Frota": null
},
{
"id": 10654,
"sequencia": 1,
"descricao": "Gare",
"quantidade": 1,
"valor_unitario": 3000,
"desconto": 0,
"PlanoConta": {
"id": 864,
"conta": "3.01.01.07.04.16.04",
"descricao": "Icms"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": null,
"Frota": null
},
{
"id": 9338,
"sequencia": 1,
"descricao": "teste",
"quantidade": 1,
"valor_unitario": 200,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": {
"id": 5,
"descricao": "projeto 10/10"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
},
{
"id": 9255,
"sequencia": 1,
"descricao": "Teste",
"quantidade": 1,
"valor_unitario": 10,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": {
"id": 5,
"descricao": "projeto 10/10"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
},
{
"id": 9254,
"sequencia": 1,
"descricao": "Teste",
"quantidade": 1,
"valor_unitario": 10,
"desconto": 0,
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": {
"id": 5,
"descricao": "projeto 10/10"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
},
{
"id": 9213,
"sequencia": 1,
"descricao": "teste",
"quantidade": 1,
"valor_unitario": 100,
"desconto": 0,
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
},
"CentroCusto": {
"id": 9,
"codigo": "1.2",
"descricao": "ADMINISTRATIVO - FINANCEIRO"
},
"Aplicacao": {
"id": 5,
"descricao": "projeto 10/10"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
},
{
"id": 501,
"sequencia": 1,
"descricao": "DESPESAS DO TIPO X",
"quantidade": 1,
"valor_unitario": 200,
"desconto": 0,
"PlanoConta": {
"id": 357,
"conta": "3.01.01.07.02.02.00",
"descricao": "Ordenados, Salários, Gratificações E Outras Remunerações A Empregados"
},
"CentroCusto": {
"id": 2,
"codigo": "2",
"descricao": "COMERCIAL"
},
"Aplicacao": null,
"Frota": null
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Itens DespesasGET/Despesa/Item{?id,documento_id,planoconta_id,descricao,valor_unitario,page,size}
Lista Itens das Despesas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a despesa pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- planoconta_id
number(optional) Example: 1332Id do Plano de Contas. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: 1332Descrição ou parte da descrição.
- valor_unitario
number(optional) Example: 15.00Valor unitário. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Despesa/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"descricao": "descrição item",
"quantidade": 10,
"valor_unitario": 15.63,
"desconto": 14.63,
"planoconta_id": 1,
"centrocusto_id": 1,
"aplicacao_id": 1,
"frota_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"descricao": {
"type": "string",
"description": "Descrição do item da Despesa"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item da Despesa"
},
"valor_unitario": {
"type": "number",
"description": "Valor do item da Despesa"
},
"desconto": {
"type": "number",
"description": "Valor do desconto do item da Despesa"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item da Despesa"
},
"centrocusto_id": {
"type": "number",
"description": "ID do centro de custo do item da Despesa"
},
"aplicacao_id": {
"type": "number",
"description": "ID da aplicação do item da Despesa"
},
"frota_id": {
"type": "number",
"description": "ID da frota do item da Despesa"
}
},
"required": [
"descricao"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 123,
"sequencia": 3,
"descricao": "Despesa de Teste 04",
"quantidade": 10,
"valor_unitario": 1000,
"desconto": 0,
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
},
"CentroCusto": {
"id": 1,
"codigo": "1",
"descricao": "ADMINISTRATIVO ..."
},
"Aplicacao": {
"id": 3,
"descricao": "veiculo y"
},
"Frota": {
"id": 1,
"descricao": "Honda Civic Preto 2012"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Item DespesaPUT/Despesa/Item/{id}
Processo de Alteração do item de uma Despesa.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| descricao | Texto | Descrição da item da despesa. | |
| quantidade | Decimal(17,6) | Quantidade do item da despesa. | |
| valor_unitario | Decimal(17,6) | Valor Unitário do item da despesa. | |
| desconto | Decimal(17,6) | Valor Desconto do item da despesa. | |
| planoconta_id | Inteiro | ID do plano de contas do item da despesa. | |
| centrocusto_id | Inteiro | ID do centro de custo do item da despesa. | |
| aplicacao_id | Inteiro | ID da aplicação do item da despesa. | |
| frota_id | Inteiro | ID da frota do item da despesa. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id do Item de Despesa
DELETE https://open-api.eprom.com.br/api/Despesa/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Item DespesaDELETE/Despesa/Item/{id}
Processo de Exclusão de um item de uma Despesa.
URI Parameters
- id
number(required) Example: 123Id do Item da Despesa
Despesas Parcelamento ¶
Endpoints relativos ao cadastro de dados de parcelamento de uma despesa.
POST https://open-api.eprom.com.br/api/Despesa/Parcelamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 4970,
"parcela": 1,
"vencimento": "2024-10-29",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Parcelamento DespesaPOST/Despesa/Parcelamento
Processo de Criação de uma pendência da Despesa. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID da Despesa. |
| parcela | ✔️ | Inteiro | Número da parcela. |
| vencimento | ✔️ | Data | Data de vencimento no formato AAAA-MM-DD. |
| valor | ✔️ | Numérico | Valor da parcela. |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
GET https://open-api.eprom.com.br/api/Despesa/Parcelamento?id=123&documento_id=1332&forma_pagto_id=1332&parcela=1&vencimento=2024-10-29&valor=150.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 199,
"data": [
{
"id": 164,
"parcela": 1,
"vencimento": "2020-03-12",
"valor": 200,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 300,
"parcela": 1,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 301,
"parcela": 2,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 302,
"parcela": 3,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 733,
"parcela": 1,
"vencimento": "2020-10-26",
"valor": 150,
"observacao": "fererereereer\r\n",
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
}
},
{
"id": 831,
"parcela": 1,
"vencimento": "2020-12-20",
"valor": 130.3,
"observacao": null,
"FormaPagamento": {
"id": 70,
"descricao": " TEST"
}
},
{
"id": 969,
"parcela": 1,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 970,
"parcela": 2,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1044,
"parcela": 1,
"vencimento": "2021-05-28",
"valor": 900,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1045,
"parcela": 2,
"vencimento": "2021-06-28",
"valor": 450,
"observacao": null,
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Parcelamento DespesasGET/Despesa/Parcelamento{?id,documento_id,forma_pagto_id,parcela,vencimento,valor,page,size}
Lista Parcelas das Despesas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a despesa pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- forma_pagto_id
number(optional) Example: 1332Id da forma de pagamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- parcela
number(optional) Example: 1Número da parcela. Poderá ser informado uma lista de valores separada por vírgula(,).
- vencimento
string(optional) Example: 2024-10-29Data de vencimento. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- valor
number(optional) Example: 150.00Valor da parcela. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Despesa/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 123,
"parcela": 1,
"vencimento": "2024-10-30",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Parcelamento DespesaPUT/Despesa/Parcelamento/{id}
Processo de Alteração de uma parcela de uma Despesa.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Número da parcela. | |
| vencimento | Data | Data de vencimento no formato AAAA-MM-DD. | |
| valor | Numérico | Valor da parcela. | |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Parcela da Despesa
DELETE https://open-api.eprom.com.br/api/Despesa/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Parcelamento DespesaDELETE/Despesa/Parcelamento/{id}
Processo de Exclusão de uma parcela de uma Despesa.
URI Parameters
- id
number(required) Example: 123Id da Parcela da Despesa
Documentos - Entradas ¶
Nesse grupo iremos trabalhar os documentos referentes a entradas.
Entrada Mercadorias ¶
Endpoints relativos à entrada de mercadorias.
POST https://open-api.eprom.com.br/api/EntradaMercadoria
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"numero": 123456,
"data_emissao": "2024-10-30 09:01:04",
"data_entrada": "2024-11-01",
"filial_id": 125,
"fornecedor_id": 125,
"local_estoque_id": 1,
"frete": 150,
"atualiza_custo": true,
"observacao": "Observação de teste",
"Itens": [
{
"produto_id": "1",
"descricao": "Item 01",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"prazo_entrega": "2024-12-31",
"planoconta_id": 1
}
],
"Pagamentos": [
{
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"forma_pagto_id": 1,
"observacao": "OBS teste"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"numero": {
"type": "number",
"description": "Número da entrada"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão da Entrada"
},
"data_entrada": {
"type": "string",
"description": "Data da Entrada da mercadoria."
},
"filial_id": {
"type": "number",
"description": "ID da Filial da Entrada."
},
"fornecedor_id": {
"type": "number",
"description": "ID da Entidade da Entrada."
},
"local_estoque_id": {
"type": "number",
"description": "ID do local de estoque."
},
"frete": {
"type": "number",
"description": "Valor do frete."
},
"atualiza_custo": {
"type": "boolean",
"description": "Atualizar custo true ou false."
},
"observacao": {
"type": "string",
"description": "Observação da Entrada."
},
"Itens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"produto_id": {
"type": "string",
"description": "ID do Produto."
},
"descricao": {
"type": "string",
"description": "Descrição do item da Entrada"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item da Entrada"
},
"preco_unitario": {
"type": "number",
"description": "Valor do item da Entrada"
},
"desconto": {
"type": "number",
"description": "Valor do item da Entrada"
},
"prazo_entrega": {
"type": "string"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item da Entrada"
}
}
},
"description": "Itens da Entrada"
},
"Pagamentos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parcela": {
"type": "number",
"description": "Número da parcela."
},
"vencimento": {
"type": "string",
"description": "Data de vencimento."
},
"valor": {
"type": "number",
"description": "Valor da parcela."
},
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento da parcela."
},
"observacao": {
"type": "string",
"description": "Observação da parcela"
}
}
},
"description": "Parcelas da Entrada"
}
},
"required": [
"fornecedor_id",
"local_estoque_id",
"frete",
"atualiza_custo",
"Itens",
"Pagamentos"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7713,
"numero": 123456,
"data_emissao": "2024-10-30T12:01:04.000Z",
"data_entrada": "2024-11-01",
"status": "PENDENTE",
"situacao": null,
"observacao": "Observação de teste",
"Origem": null,
"Fornecedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11713,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
],
"Pagamentos": [
{
"id": 4973,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4974,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Entrada MercadoriasPOST/EntradaMercadoria
Processo de Criação de uma Entrada de Mercadorias. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão da entrada de mercadorias. Formato 2024-10-20 23:53:51. | |
| data_entrada | Data Hora | Informar a data hora de entrada da entrada de mercadorias. Formato 2024-10-20 23:53:51. | |
| filial_id | Inteiro | Informar o ID da Filial da Entrada de Mercadoria. | |
| fornecedor_id | ✔️ | Inteiro | Informar o ID do fornecedor referete a entrada de mercadorias. |
| local_estoque_id | Inteiro | Informar o ID do local de estoque referete a entrada de mercadorias. | |
| frete | Número | Informar o valor do frete. | |
| atualiza_custo | Booleano | Informar se atualizará custo ou não do produto. | |
| observacao | Texto | Informar a Observação da entrada de mercadorias. | |
| Itens | ✔️ | TipoDocEntradaItem[ ] | Conjunto de Itens da Entrada de Mercadoria. |
| Pagamentos | ✔️ | TipoDocEntradaPag[ ] | Conjunto de dados referente ao Pagamento da Entrada de Mercadoria. |
Tipos de dados usados:
Itens de uma Entrada de Mercadorias
TipoDocEntradaItem
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
produto_id
Inteiro
Informar o ID do produto da Entrada.
descricao
Texto
Descrição da item da Entrada.
quantidade
Decimal(17,6)
Quantidade do item da Entrada.
preco_unitario
Decimal(17,6)
Valor Unitário do item da Entrada.
desconto
Decimal(17,6)
Valor Desconto do item da Entrada.
prazo_entrega
Data
Informar a data da previsão de entrega do item da Entrada.
planoconta_id
Inteiro
ID do plano de contas do item da Entrada.
TipoDocEntradaItem
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | Inteiro | Informar o ID do produto da Entrada. | |
| descricao | Texto | Descrição da item da Entrada. | |
| quantidade | Decimal(17,6) | Quantidade do item da Entrada. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item da Entrada. | |
| desconto | Decimal(17,6) | Valor Desconto do item da Entrada. | |
| prazo_entrega | Data | Informar a data da previsão de entrega do item da Entrada. | |
| planoconta_id | Inteiro | ID do plano de contas do item da Entrada. |
Itens de um pagamento de uma Entrada
TipoDocEntradaPag
Os campos que compõem uma parcela de um pagamento de uma entrada são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
parcela
Inteiro
Informar o número da parcela.
vencimento
Data
Informar a data de vencimento da parcela.
valor
Decimal(15,2)
Informar o valor da parcela.
forma_pagto_id
Inteiro
Informar o ID da forma de pagamento da parcela.
observacao
String(50)
Informar a observação da parcela.
TipoDocEntradaPag
Os campos que compõem uma parcela de um pagamento de uma entrada são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Informar o número da parcela. | |
| vencimento | Data | Informar a data de vencimento da parcela. | |
| valor | Decimal(15,2) | Informar o valor da parcela. | |
| forma_pagto_id | Inteiro | Informar o ID da forma de pagamento da parcela. | |
| observacao | String(50) | Informar a observação da parcela. |
GET https://open-api.eprom.com.br/api/EntradaMercadoria?id=123&numero=1332&data_emissao=2024-10-01&data_entrada=2024-10-02&status=PENDENTE&situacao=ENVIADO&fornecedor_id=1332&filial_id=1332&local_estoque_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 13,
"data": [
{
"id": 938,
"numero": 0,
"data_emissao": "2020-08-25T08:17:08.000Z",
"data_entrada": "2020-08-25",
"status": "CONCLUIDO",
"situacao": "CONCLUIDO",
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 18,
"nome": "Sim Cordeiro Itarare"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 1454,
"sequencia": 1,
"descricao": "REGUA 30 CM TRIDENT\r\n",
"referencia": null,
"quantidade": 10,
"preco_unitario": 11.65,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2020-08-25",
"observacao": null,
"Produto": {
"id": 19,
"descricao_reduzida": "Louças Assento Tcp/k*vda-51",
"descricao_completa": "Louças Assento Tcp/k*vda-51"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 1455,
"sequencia": 2,
"descricao": "CANETA BIC\r\n",
"referencia": null,
"quantidade": 5,
"preco_unitario": 129,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2020-08-25",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
],
"Pagamentos": []
},
{
"id": 4881,
"numero": null,
"data_emissao": "2022-02-02T08:57:48.000Z",
"data_entrada": "2022-02-02",
"status": "CONCLUIDO",
"situacao": "CONCLUIDO",
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 7233,
"sequencia": 1,
"descricao": "CANETA BIC",
"referencia": null,
"quantidade": 1,
"preco_unitario": 10390,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2022-02-02",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 867,
"conta": "3.01.01.09.01.99.14",
"descricao": "Comissões Pagas A Terceiros"
}
},
{
"id": 7234,
"sequencia": 2,
"descricao": "CANETA BIC",
"referencia": null,
"quantidade": 1,
"preco_unitario": 9610,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2022-02-02",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 832,
"conta": "3.01.01.09.01.99.03",
"descricao": "Aluguel"
}
}
],
"Pagamentos": [
{
"id": 2653,
"parcela": 1,
"vencimento": "2022-02-02",
"valor": 20000,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
},
{
"id": 5894,
"numero": null,
"data_emissao": "2023-03-31T03:00:00.000Z",
"data_entrada": "2023-03-31",
"status": "PENDENTE",
"situacao": "PENDENTE",
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 8667,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "abc13664",
"quantidade": 700,
"preco_unitario": 400,
"desconto": 0,
"frete": 74.9,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2023-04-03",
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 828,
"conta": "3.01.01.01.01.04.06",
"descricao": "Venda"
}
},
{
"id": 8668,
"sequencia": 2,
"descricao": "Bebedouro De 50 Ml Branco",
"referencia": "123456",
"quantidade": 5.06,
"preco_unitario": 74.25,
"desconto": 0,
"frete": 0.1,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2023-04-03",
"observacao": null,
"Produto": {
"id": 302,
"descricao_reduzida": "Bebedouro De 50 Ml Branco",
"descricao_completa": "Bebedouro De 50 Ml Branco"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 828,
"conta": "3.01.01.01.01.04.06",
"descricao": "Venda"
}
}
],
"Pagamentos": [
{
"id": 4449,
"parcela": 1,
"vencimento": "2023-05-01",
"valor": 280450.71,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
]
},
{
"id": 6858,
"numero": null,
"data_emissao": "2024-04-03T21:11:00.000Z",
"data_entrada": "2024-04-03",
"status": "CONCLUIDO",
"situacao": "CONCLUIDO",
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 430,
"nome": "Tiago Fontes Saggioro"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 10612,
"sequencia": 1,
"descricao": "Caneta Bic",
"referencia": "000001",
"quantidade": 0,
"preco_unitario": 3,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
}
],
"Pagamentos": [
{
"id": 4727,
"parcela": 1,
"vencimento": "2024-04-03",
"valor": 3,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
]
},
{
"id": 6878,
"numero": null,
"data_emissao": "2024-04-05T19:29:32.000Z",
"data_entrada": "2024-04-05",
"status": "PENDENTE",
"situacao": null,
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 51833,
"nome": "Aaron Baccili Masiero Linares"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 10627,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 0,
"preco_unitario": 50,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
},
{
"id": 10630,
"sequencia": 2,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "013664",
"quantidade": 0,
"preco_unitario": 411.2,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
}
],
"Pagamentos": [
{
"id": 4190,
"parcela": 1,
"vencimento": "2024-04-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4191,
"parcela": 2,
"vencimento": "2024-05-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4192,
"parcela": 3,
"vencimento": "2024-06-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4193,
"parcela": 4,
"vencimento": "2024-07-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4194,
"parcela": 5,
"vencimento": "2024-08-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4195,
"parcela": 6,
"vencimento": "2024-09-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4196,
"parcela": 7,
"vencimento": "2024-10-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4197,
"parcela": 8,
"vencimento": "2024-11-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4198,
"parcela": 9,
"vencimento": "2024-12-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4199,
"parcela": 10,
"vencimento": "2025-01-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4200,
"parcela": 11,
"vencimento": "2025-02-15",
"valor": 38.46,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
},
{
"id": 4201,
"parcela": 12,
"vencimento": "2025-03-15",
"valor": 38.14,
"observacao": null,
"FormaPagamento": {
"id": 22,
"descricao": "CARTAO DE DEBITO"
}
}
]
},
{
"id": 6880,
"numero": null,
"data_emissao": "2024-04-05T19:37:15.000Z",
"data_entrada": "2024-04-05",
"status": "PENDENTE",
"situacao": null,
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 51833,
"nome": "Aaron Baccili Masiero Linares"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 10628,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 10,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 279,
"conta": "3.01.01.01.03.01.00",
"descricao": "(-) Vendas Canceladas, Devoluções E Descontos Incondicionais"
}
},
{
"id": 10629,
"sequencia": 2,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "013664",
"quantidade": 1,
"preco_unitario": 411.2,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
}
],
"Pagamentos": [
{
"id": 4202,
"parcela": 1,
"vencimento": "2024-04-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4203,
"parcela": 2,
"vencimento": "2024-05-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4204,
"parcela": 3,
"vencimento": "2024-06-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4205,
"parcela": 4,
"vencimento": "2024-07-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4206,
"parcela": 5,
"vencimento": "2024-08-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4207,
"parcela": 6,
"vencimento": "2024-09-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4208,
"parcela": 7,
"vencimento": "2024-10-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4209,
"parcela": 8,
"vencimento": "2024-11-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4210,
"parcela": 9,
"vencimento": "2024-12-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4211,
"parcela": 10,
"vencimento": "2025-01-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4212,
"parcela": 11,
"vencimento": "2025-02-15",
"valor": 34.96,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 4213,
"parcela": 12,
"vencimento": "2025-03-15",
"valor": 36.64,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
},
{
"id": 7336,
"numero": null,
"data_emissao": "2024-06-25T14:20:31.000Z",
"data_entrada": "2024-06-25",
"status": "CONCLUIDO",
"situacao": "CONCLUIDO",
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 430,
"nome": "Tiago Fontes Saggioro"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 11199,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 1,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
}
],
"Pagamentos": [
{
"id": 4578,
"parcela": 1,
"vencimento": "2024-06-25",
"valor": 1,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
},
{
"id": 7368,
"numero": null,
"data_emissao": "2024-07-03T11:25:41.000Z",
"data_entrada": "2024-07-03",
"status": "PENDENTE",
"situacao": null,
"observacao": null,
"Origem": {
"id": 6625,
"tipo": "PEDIDO DE COMPRAS - COMPRA",
"numero": null
},
"Fornecedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 11224,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "013664",
"quantidade": 1,
"preco_unitario": 421.08,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 281,
"conta": "3.01.01.01.03.03.00",
"descricao": "(-) Cofins"
}
}
],
"Pagamentos": [
{
"id": 4658,
"parcela": 1,
"vencimento": "2024-07-03",
"valor": 421.08,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
},
{
"id": 7464,
"numero": null,
"data_emissao": "2024-08-12T12:51:39.000Z",
"data_entrada": "2024-08-12",
"status": "PENDENTE",
"situacao": null,
"observacao": null,
"Origem": null,
"Fornecedor": {
"id": 430,
"nome": "Tiago Fontes Saggioro"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11353,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escritório Preta",
"referencia": "2546723425",
"quantidade": 1,
"preco_unitario": 421.08,
"desconto": 0,
"frete": 50,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
}
],
"Pagamentos": [
{
"id": 4826,
"parcela": 1,
"vencimento": "2024-08-13",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4827,
"parcela": 2,
"vencimento": "2024-09-12",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4828,
"parcela": 3,
"vencimento": "2024-10-12",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4829,
"parcela": 4,
"vencimento": "2024-11-11",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4830,
"parcela": 5,
"vencimento": "2024-12-11",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4831,
"parcela": 6,
"vencimento": "2025-01-10",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4832,
"parcela": 7,
"vencimento": "2025-02-09",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4833,
"parcela": 8,
"vencimento": "2025-03-11",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4834,
"parcela": 9,
"vencimento": "2025-04-10",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4835,
"parcela": 10,
"vencimento": "2025-05-10",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4836,
"parcela": 11,
"vencimento": "2025-06-09",
"valor": 39.26,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4837,
"parcela": 12,
"vencimento": "2025-07-09",
"valor": 39.22,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
]
},
{
"id": 7469,
"numero": null,
"data_emissao": "2024-08-12T14:19:52.000Z",
"data_entrada": "2024-08-12",
"status": "CONCLUIDO",
"situacao": "CONCLUIDO",
"observacao": null,
"Origem": {
"id": 6628,
"tipo": "PEDIDO DE COMPRAS - COMPRA",
"numero": 123456
},
"Fornecedor": {
"id": 82026,
"nome": "Batistaevaristo Honda Fide Paz"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Itens": [
{
"id": 11358,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "2546723425",
"quantidade": 1,
"preco_unitario": 421.08,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 279,
"conta": "3.01.01.01.03.01.00",
"descricao": "(-) Vendas Canceladas, Devoluções E Descontos Incondicionais"
}
}
],
"Pagamentos": [
{
"id": 4736,
"parcela": 1,
"vencimento": "2024-08-12",
"valor": 421.08,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar EntradasGET/EntradaMercadoria{?id,numero,data_emissao,data_entrada,status,situacao,fornecedor_id,filial_id,local_estoque_id,page,size}
Lista Entradas de mercadorias.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a entrada pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 2024-10-01Data de emissão da entrada. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- data_entrada
string(optional) Example: 2024-10-02Data de entrada da mercadoria. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTECONCLUIDOCANCELADO- situacao
string(optional) Example: ENVIADOSituação do documento. Poderá ser informado uma lista de valores separada por vírgula(,). As situações são as descrições constantes nos status do documento do sistema.
- fornecedor_id
number(optional) Example: 1332ID do fornecedor da entrada. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
string(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- local_estoque_id
string(optional) Example: 1332ID do local do estoque. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/EntradaMercadoria/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"numero": 123456,
"data_emissao": "2024-10-30 09:01:04",
"data_entrada": "2024-11-01",
"filial_id": 125,
"fornecedor_id": 125,
"local_estoque_id": 1,
"frete": 150,
"atualiza_custo": true,
"observacao": "Observação de teste"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"numero": {
"type": "number",
"description": "Número da entrada"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão da Entrada"
},
"data_entrada": {
"type": "string",
"description": "Data da Entrada da mercadoria."
},
"filial_id": {
"type": "number",
"description": "ID da Filial da Entrada."
},
"fornecedor_id": {
"type": "number",
"description": "ID da Entidade da Entrada."
},
"local_estoque_id": {
"type": "number",
"description": "ID do local de estoque."
},
"frete": {
"type": "number",
"description": "Valor do frete."
},
"atualiza_custo": {
"type": "boolean",
"description": "Atualizar custo true ou false."
},
"observacao": {
"type": "string",
"description": "Observação da Entrada."
}
},
"required": [
"fornecedor_id",
"local_estoque_id",
"frete",
"atualiza_custo"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7713,
"numero": 12345678,
"data_emissao": "2024-10-30T12:01:04.000Z",
"data_entrada": "2024-11-01",
"status": "PENDENTE",
"situacao": null,
"observacao": "Observação de teste",
"Origem": null,
"Fornecedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11713,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
],
"Pagamentos": [
{
"id": 4973,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4974,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração EntradasPUT/EntradaMercadoria/{id}
Processo de Alteração de uma Entrada.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão da entrada de mercadorias. Formato 2024-10-20 23:53:51. | |
| data_entrada | Data Hora | Informar a data hora de entrada da entrada de mercadorias. Formato 2024-10-20 23:53:51. | |
| filial_id | Inteiro | Informar o ID da Filial da Entrada de Mercadoria. | |
| fornecedor_id | Inteiro | Informar o ID do fornecedor referete a entrada de mercadorias. | |
| local_estoque_id | Inteiro | Informar o ID do local de estoque referete a entrada de mercadorias. | |
| frete | Número | Informar o valor do frete. | |
| atualiza_custo | Booleano | Informar se atualizará custo ou não do produto. | |
| observacao | Texto | Informar a Observação da entrada de mercadorias. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Entrada
DELETE https://open-api.eprom.com.br/api/EntradaMercadoria/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Documento excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão EntradaDELETE/EntradaMercadoria/{id}
Processo de Exclusão da Entrada.
URI Parameters
- id
number(required) Example: 123Id da Entrada
Entrada Itens ¶
Endpoints relativos ao cadastro de itens de uma entrada.
POST https://open-api.eprom.com.br/api/EntradaMercadoria/Item
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11717,
"sequencia": 3,
"descricao": "Produto de Teste 02",
"referencia": "000002",
"quantidade": 10,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-10-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Item EntradaPOST/EntradaMercadoria/Item
Processo de Criação de itens de uma entrada. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID da Entrada. |
| produto_id | Inteiro | Informar o ID do produto da Entrada. | |
| descricao | Texto | Descrição da item da Entrada. | |
| quantidade | Decimal(17,6) | Quantidade do item da Entrada. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item da Entrada. | |
| desconto | Decimal(17,6) | Valor Desconto do item da Entrada. | |
| prazo_de_entrega | Data | Informar a data da previsão de entrega do item da Entrada. | |
| planoconta_id | Inteiro | ID do plano de contas do item da Entrada. |
GET https://open-api.eprom.com.br/api/EntradaMercadoria/Item?id=123&documento_id=1332&produto_id=1332&planoconta_id=1332&descricao=1332&preco_unitario=15.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 23,
"data": [
{
"id": 1454,
"sequencia": 1,
"descricao": "REGUA 30 CM TRIDENT\r\n",
"referencia": null,
"quantidade": 10,
"preco_unitario": 11.65,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2020-08-25",
"observacao": null,
"Produto": {
"id": 19,
"descricao_reduzida": "Louças Assento Tcp/k*vda-51",
"descricao_completa": "Louças Assento Tcp/k*vda-51"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11620,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escrotório azul",
"referencia": "013664-XP",
"quantidade": 1,
"preco_unitario": 200,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 124488,
"descricao_reduzida": "Cadeira Para Escrotório",
"descricao_completa": "Cadeira Cadeira Para Escrotório azul"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
},
{
"id": 11358,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "2546723425",
"quantidade": 1,
"preco_unitario": 421.08,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 279,
"conta": "3.01.01.01.03.01.00",
"descricao": "(-) Vendas Canceladas, Devoluções E Descontos Incondicionais"
}
},
{
"id": 11353,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escritório Preta",
"referencia": "2546723425",
"quantidade": 1,
"preco_unitario": 421.08,
"desconto": 0,
"frete": 50,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
},
{
"id": 11224,
"sequencia": 1,
"descricao": "Cadeira Cadeira Para Escrotório Preta",
"referencia": "013664",
"quantidade": 1,
"preco_unitario": 421.08,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 101,
"descricao_reduzida": "Cadeira Para Escritório",
"descricao_completa": "Cadeira Cadeira Para Escritório Preta"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 281,
"conta": "3.01.01.01.03.03.00",
"descricao": "(-) Cofins"
}
},
{
"id": 11199,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 1,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
},
{
"id": 11621,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 10628,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 10,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 279,
"conta": "3.01.01.01.03.01.00",
"descricao": "(-) Vendas Canceladas, Devoluções E Descontos Incondicionais"
}
},
{
"id": 10627,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 0,
"preco_unitario": 50,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 277,
"conta": "3.01.01.01.01.07.00",
"descricao": "Outras"
}
},
{
"id": 7233,
"sequencia": 1,
"descricao": "CANETA BIC",
"referencia": null,
"quantidade": 1,
"preco_unitario": 10390,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2022-02-02",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 867,
"conta": "3.01.01.09.01.99.14",
"descricao": "Comissões Pagas A Terceiros"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Itens EntradasGET/EntradaMercadoria/Item{?id,documento_id,produto_id,planoconta_id,descricao,preco_unitario,page,size}
Lista Itens das Entradas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a entrada pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- planoconta_id
number(optional) Example: 1332Id do Plano de Contas. Poderá ser informado uma lista de valores separada por vírgula(,).
- produto_id
number(optional) Example: 1332Id do Produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: 1332Descrição ou parte da descrição.
- preco_unitario
number(optional) Example: 15.00Preço unitário. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/EntradaMercadoria/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"produto_id": "1",
"descricao": "Item 01",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"prazo_de_entrega": "2024-12-31",
"planoconta_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"produto_id": {
"type": "string",
"description": "ID do Produto."
},
"descricao": {
"type": "string",
"description": "Descrição do item da Entrada"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item da Entrada"
},
"preco_unitario": {
"type": "number",
"description": "Valor do item da Entrada"
},
"desconto": {
"type": "number",
"description": "Valor do item da Entrada"
},
"prazo_de_entrega": {
"type": "string"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item da Entrada"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11717,
"sequencia": 3,
"descricao": "Produto de Teste 01",
"referencia": "000002",
"quantidade": 10,
"preco_unitario": 200,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-10-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Item EntradaPUT/EntradaMercadoria/Item/{id}
Processo de Alteração do item de uma Entrada.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | Inteiro | Informar o ID do produto da Entrada. | |
| descricao | Texto | Descrição da item da Entrada. | |
| quantidade | Decimal(17,6) | Quantidade do item da Entrada. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item da Entrada. | |
| desconto | Decimal(17,6) | Valor Desconto do item da Entrada. | |
| prazo_de_entrega | Data | Informar a data da previsão de entrega do item da Entrada. | |
| planoconta_id | Inteiro | ID do plano de contas do item da Entrada. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id do Item de Entrada
DELETE https://open-api.eprom.com.br/api/EntradaMercadoria/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Item EntradaDELETE/EntradaMercadoria/Item/{id}
Processo de Exclusão de um item de uma Entrada.
URI Parameters
- id
number(required) Example: 123Id do Item de Entrada
Entradas Parcelamento ¶
Endpoints relativos ao cadastro de dados de parcelamento de uma Entrada.
POST https://open-api.eprom.com.br/api/EntradaMercadoria/Parcelamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 4970,
"parcela": 1,
"vencimento": "2024-10-29",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Parcelamento EntradaPOST/EntradaMercadoria/Parcelamento
Processo de Criação de uma pendência da Entrada. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID da Entrada. |
| parcela | ✔️ | Inteiro | Número da parcela. |
| vencimento | ✔️ | Data | Data de vencimento no formato AAAA-MM-DD. |
| valor | ✔️ | Numérico | Valor da parcela. |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
GET https://open-api.eprom.com.br/api/EntradaMercadoria/Parcelamento?id=123&documento_id=1332&forma_pagto_id=1332&parcela=1&vencimento=2024-10-29&valor=150.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 199,
"data": [
{
"id": 164,
"parcela": 1,
"vencimento": "2020-03-12",
"valor": 200,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 300,
"parcela": 1,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 301,
"parcela": 2,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 302,
"parcela": 3,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 733,
"parcela": 1,
"vencimento": "2020-10-26",
"valor": 150,
"observacao": "fererereereer\r\n",
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
}
},
{
"id": 831,
"parcela": 1,
"vencimento": "2020-12-20",
"valor": 130.3,
"observacao": null,
"FormaPagamento": {
"id": 70,
"descricao": " TEST"
}
},
{
"id": 969,
"parcela": 1,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 970,
"parcela": 2,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1044,
"parcela": 1,
"vencimento": "2021-05-28",
"valor": 900,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1045,
"parcela": 2,
"vencimento": "2021-06-28",
"valor": 450,
"observacao": null,
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Parcelamento EntradasGET/EntradaMercadoria/Parcelamento{?id,documento_id,forma_pagto_id,parcela,vencimento,valor,page,size}
Lista Parcelamentos de uma Entrada.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Entrada pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- forma_pagto_id
number(optional) Example: 1332Id da forma de pagamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- parcela
number(optional) Example: 1Número da parcela. Poderá ser informado uma lista de valores separada por vírgula(,).
- vencimento
string(optional) Example: 2024-10-29Data de vencimento. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- valor
number(optional) Example: 150.00Valor da parcela. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/EntradaMercadoria/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 123,
"parcela": 1,
"vencimento": "2024-10-30",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Parcelamento EntradaPUT/EntradaMercadoria/Parcelamento/{id}
Processo de Alteração do item de um item de parcelamento.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Número da parcela. | |
| vencimento | Data | Data de vencimento no formato AAAA-MM-DD. | |
| valor | Numérico | Valor da parcela. | |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Parcela da Entrada
DELETE https://open-api.eprom.com.br/api/EntradaMercadoria/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Parcelamento EntradaDELETE/EntradaMercadoria/Parcelamento/{id}
Processo de Exclusão de um item de um parcelamento.
URI Parameters
- id
number(required) Example: 123Id da Parcela da Entrada
Documentos - Faturas ¶
Nesse grupo iremos trabalhar os documentos referentes a faturas.
Faturas ¶
Endpoints relativos à Fatura.
POST https://open-api.eprom.com.br/api/Fatura
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"numero": 123456,
"data_emissao": "2024-10-30 09:01:04",
"filial_id": 125,
"cliente_id": 125,
"vendedor_id": 1,
"local_estoque_id": 1,
"endereco_entrega_id": 1,
"frete": 150,
"observacao": "Observação de teste",
"Itens": [
{
"produto_id": "1",
"descricao": "Item 01",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"prazo_entrega": "2024-12-31",
"planoconta_id": 1
}
],
"Pagamentos": [
{
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"forma_pagto_id": 1,
"observacao": "OBS teste"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"numero": {
"type": "number",
"description": "Número da Fatura"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão da Fatura"
},
"filial_id": {
"type": "number",
"description": "ID da Filial da Fatura."
},
"cliente_id": {
"type": "number",
"description": "ID do Cliente da Fatura."
},
"vendedor_id": {
"type": "number",
"description": "ID do vendedor da Fatura."
},
"local_estoque_id": {
"type": "number",
"description": "ID do local de estoque."
},
"endereco_entrega_id": {
"type": "number",
"description": "ID do local de entrega da fatura."
},
"frete": {
"type": "number",
"description": "Valor do frete."
},
"observacao": {
"type": "string",
"description": "Observação da Fatura."
},
"Itens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"produto_id": {
"type": "string",
"description": "ID do Produto."
},
"descricao": {
"type": "string",
"description": "Descrição do item da Fatura"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item da Fatura"
},
"preco_unitario": {
"type": "number",
"description": "Valor do item da Fatura"
},
"desconto": {
"type": "number",
"description": "Valor do item da Fatura"
},
"prazo_entrega": {
"type": "string"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item da Fatura"
}
}
},
"description": "Itens da Fatura"
},
"Pagamentos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parcela": {
"type": "number",
"description": "Número da parcela."
},
"vencimento": {
"type": "string",
"description": "Data de vencimento."
},
"valor": {
"type": "number",
"description": "Valor da parcela."
},
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento da parcela."
},
"observacao": {
"type": "string",
"description": "Observação da parcela"
}
}
},
"description": "Parcelas da Fatura"
}
},
"required": [
"cliente_id",
"vendedor_id",
"local_estoque_id",
"endereco_entrega_id",
"frete",
"Itens",
"Pagamentos"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7716,
"numero": 123456,
"data_emissao": "2024-10-30T14:40:15.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11718,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 11719,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 100,
"desconto": 0,
"frete": 125,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
],
"Pagamentos": [
{
"id": 4977,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4978,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação FaturaPOST/Fatura
Processo de Criação de uma Fatura. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão da Fatura. Formato 2024-10-20 23:53:51. | |
| filial_id | Inteiro | Informar o ID da Filial da Fatura de Mercadoria. | |
| cliente_id | ✔️ | Inteiro | Informar o ID do Cliente referete a Fatura. |
| vendedor_id | Inteiro | Informar o ID do Vendedor referete a Fatura. | |
| local_estoque_id | Inteiro | Informar o ID do local de estoque referete a Fatura. | |
| endereco_entrega_id | Inteiro | Informar o ID do endereço de entrega da Fatura. | |
| frete | Número | Informar o valor do frete. | |
| observacao | Texto | Informar a Observação da Fatura. | |
| Itens | ✔️ | TipoDocFaturaItem[ ] | Conjunto de Itens da Fatura de Mercadoria. |
| Pagamentos | ✔️ | TipoDocFaturaPag[ ] | Conjunto de dados referente ao Pagamento da Fatura de Mercadoria. |
Tipos de dados usados:
Itens de uma Fatura
TipoDocFaturaItem
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
produto_id
Inteiro
Informar o ID do produto da Fatura.
descricao
Texto
Descrição da item da Fatura.
quantidade
Decimal(17,6)
Quantidade do item da Fatura.
preco_unitario
Decimal(17,6)
Valor Unitário do item da Fatura.
desconto
Decimal(17,6)
Valor Desconto do item da Fatura.
prazo_entrega
Data
Informar a data da previsão de entrega do item da Fatura.
planoconta_id
Inteiro
ID do plano de contas do item da Fatura.
TipoDocFaturaItem
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | Inteiro | Informar o ID do produto da Fatura. | |
| descricao | Texto | Descrição da item da Fatura. | |
| quantidade | Decimal(17,6) | Quantidade do item da Fatura. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item da Fatura. | |
| desconto | Decimal(17,6) | Valor Desconto do item da Fatura. | |
| prazo_entrega | Data | Informar a data da previsão de entrega do item da Fatura. | |
| planoconta_id | Inteiro | ID do plano de contas do item da Fatura. |
Itens de um pagamento de uma Fatura
TipoDocFaturaPag
Os campos que compõem uma parcela de um pagamento de uma Fatura são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
parcela
Inteiro
Informar o número da parcela.
vencimento
Data
Informar a data de vencimento da parcela.
valor
Decimal(15,2)
Informar o valor da parcela.
forma_pagto_id
Inteiro
Informar o ID da forma de pagamento da parcela.
observacao
String(50)
Informar a observação da parcela.
TipoDocFaturaPag
Os campos que compõem uma parcela de um pagamento de uma Fatura são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Informar o número da parcela. | |
| vencimento | Data | Informar a data de vencimento da parcela. | |
| valor | Decimal(15,2) | Informar o valor da parcela. | |
| forma_pagto_id | Inteiro | Informar o ID da forma de pagamento da parcela. | |
| observacao | String(50) | Informar a observação da parcela. |
GET https://open-api.eprom.com.br/api/Fatura?id=123&numero=1332&data_emissao=2024-10-01&status=PENDENTE&cliente_id=1332&filial_id=1332&vendedor_id=1332&local_estoque_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 12,
"data": [
{
"id": 7380,
"numero": null,
"data_emissao": "2024-07-12T19:01:12.000Z",
"status": "CONCLUIDO",
"observacao": "",
"Origem": {
"id": 7373,
"tipo": "ORDEM DE SERVIÇO - SERVICOS",
"numero": null
},
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 430,
"nome": "Tiago Fontes Saggioro"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": [
{
"id": 11236,
"sequencia": 1,
"descricao": "Manutenção",
"referencia": null,
"quantidade": 1,
"preco_unitario": 15,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": null,
"UnidadeMedida": null,
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
}
]
},
{
"id": 7389,
"numero": null,
"data_emissao": "2024-07-19T20:09:52.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": {
"id": 55823,
"uf": "SP",
"cep": "17203-480",
"pais": "BRASIL",
"bairro": "Jardim Estadio",
"cidade": "JAU",
"numero": "55823",
"logradouro": "Rua Angelo Martins",
"codigo_ibge": 3525300,
"complemento": null,
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
}
},
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 51833,
"nome": "Aaron Baccili Masiero Linares"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4877,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4878,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11252,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 0,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7395,
"numero": null,
"data_emissao": "2024-07-30T11:53:52.000Z",
"status": "CONCLUIDO",
"observacao": "",
"Origem": {
"id": 7383,
"tipo": "ORDEM DE SERVIÇO - SERVICOS",
"numero": null
},
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": [
{
"id": 11264,
"sequencia": 1,
"descricao": "Manutenção (07/2024)",
"referencia": null,
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": null,
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
},
{
"id": 11265,
"sequencia": 2,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
},
{
"id": 11266,
"sequencia": 3,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
},
{
"id": 11267,
"sequencia": 4,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
}
]
},
{
"id": 7454,
"numero": null,
"data_emissao": "2024-08-06T17:59:38.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 27,
"nome": "Agonezi Murillo Amato"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": []
},
{
"id": 7485,
"numero": null,
"data_emissao": "2024-08-16T14:59:29.000Z",
"status": "CONCLUIDO",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 10254,
"nome": "Aldine Malaspina Eprom"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4756,
"parcela": 1,
"vencimento": "2024-09-15",
"valor": 16.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
],
"Itens": [
{
"id": 11388,
"sequencia": 1,
"descricao": "Poltrona",
"referencia": "013674",
"quantidade": 1,
"preco_unitario": 16.5,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 110,
"descricao_reduzida": "Poltrona",
"descricao_completa": "Poltrona"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7608,
"numero": null,
"data_emissao": "2024-10-02T17:22:58.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 98188,
"nome": "entidade teste"
},
"Cliente": {
"id": 51833,
"nome": "Aaron Baccili Masiero Linares"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4811,
"parcela": 1,
"vencimento": "2024-10-02",
"valor": 5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4812,
"parcela": 2,
"vencimento": "2024-10-12",
"valor": 5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
],
"Itens": [
{
"id": 11559,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 10,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7621,
"numero": null,
"data_emissao": "2024-10-04T13:05:47.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 11622,
"nome": "Abadias Sparapan Jesuslima"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": [
{
"id": 11574,
"sequencia": 1,
"descricao": "(65) Broca De Aco Rapido (e) 1/8",
"referencia": "018390",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 18390,
"descricao_reduzida": "(65) Broca De Aco Rapido (e)",
"descricao_completa": "(65) Broca De Aco Rapido (e) 1/8"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7636,
"numero": null,
"data_emissao": "2024-10-09T13:32:15.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": {
"id": 6562,
"tipo": "PEDIDO DE VENDA - VENDA",
"numero": 27
},
"EnderecoEntrega": null,
"Vendedor": {
"id": 27,
"nome": "Agonezi Murillo Amato"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4886,
"parcela": 1,
"vencimento": "2024-11-08",
"valor": 131.57,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4887,
"parcela": 2,
"vencimento": "2024-12-08",
"valor": 59.48,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4888,
"parcela": 3,
"vencimento": "2025-01-07",
"valor": 59.48,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4889,
"parcela": 4,
"vencimento": "2025-02-06",
"valor": 59.47,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11592,
"sequencia": 1,
"descricao": "Caneta Bic",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 30,
"desconto": 0,
"frete": 10,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7641,
"numero": 123456,
"data_emissao": "2024-10-09T17:20:14.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Pagamentos": [
{
"id": 4848,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 13.64,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4849,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 13.64,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11597,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 11.88,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11598,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 3.08,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7642,
"numero": 12345678,
"data_emissao": "2024-10-09T17:20:59.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Pagamentos": [
{
"id": 4850,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4851,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11599,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11600,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 100,
"desconto": 0,
"frete": 125,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar FaturasGET/Fatura{?id,numero,data_emissao,status,cliente_id,filial_id,vendedor_id,local_estoque_id,page,size}
Lista Faturas de mercadorias.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Fatura pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 2024-10-01Data de emissão da Fatura. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTECONCLUIDOCANCELADO- cliente_id
number(optional) Example: 1332ID do fornecedor da Fatura. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
string(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- vendedor_id
string(optional) Example: 1332ID do Vendedor. Poderá ser informado uma lista de valores separada por vírgula(,).
- local_estoque_id
string(optional) Example: 1332ID do local do estoque. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Fatura/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"numero": 123456,
"data_emissao": "2024-10-30 09:01:04",
"filial_id": 125,
"cliente_id": 125,
"vendedor_id": 1,
"local_estoque_id": 1,
"endereco_entrega_id": 1,
"frete": 150,
"observacao": "Observação de teste"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"numero": {
"type": "number",
"description": "Número da Fatura"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão da Fatura"
},
"filial_id": {
"type": "number",
"description": "ID da Filial da Fatura."
},
"cliente_id": {
"type": "number",
"description": "ID do Cliente da Fatura."
},
"vendedor_id": {
"type": "number",
"description": "ID do vendedor da Fatura."
},
"local_estoque_id": {
"type": "number",
"description": "ID do local de estoque."
},
"endereco_entrega_id": {
"type": "number",
"description": "ID do local de entrega da fatura."
},
"frete": {
"type": "number",
"description": "Valor do frete."
},
"observacao": {
"type": "string",
"description": "Observação da Fatura."
}
},
"required": [
"cliente_id",
"vendedor_id",
"local_estoque_id",
"endereco_entrega_id",
"frete"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7716,
"numero": 12345678,
"data_emissao": "2024-10-30T14:40:15.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11718,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 11719,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 100,
"desconto": 0,
"frete": 125,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
],
"Pagamentos": [
{
"id": 4977,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4978,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração FaturasPUT/Fatura/{id}
Processo de Alteração de uma Fatura.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão da Fatura. Formato 2024-10-20 23:53:51. | |
| filial_id | Inteiro | Informar o ID da Filial da Fatura de Mercadoria. | |
| cliente_id | Inteiro | Informar o ID do Cliente referete a Fatura. | |
| vendedor_id | Inteiro | Informar o ID do Vendedor referete a Fatura. | |
| local_estoque_id | Inteiro | Informar o ID do local de estoque referete a Fatura. | |
| endereco_entrega_id | Inteiro | Informar o ID do endereço de entrega da Fatura. | |
| frete | Número | Informar o valor do frete. | |
| observacao | Texto | Informar a Observação da Fatura. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Fatura
DELETE https://open-api.eprom.com.br/api/Fatura/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Documento excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão FaturaDELETE/Fatura/{id}
Processo de Exclusão da Fatura.
URI Parameters
- id
number(required) Example: 123Id da Fatura
Fatura Itens ¶
Endpoints relativos ao cadastro de itens de uma Fatura.
POST https://open-api.eprom.com.br/api/Fatura/Item
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11720,
"sequencia": 3,
"descricao": "Produto de Teste 01",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-10-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Item FaturaPOST/Fatura/Item
Processo de Criação de itens de uma Fatura. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID da Fatura. |
| produto_id | Inteiro | Informar o ID do produto da Fatura. | |
| descricao | Texto | Descrição da item da Fatura. | |
| quantidade | Decimal(17,6) | Quantidade do item da Fatura. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item da Fatura. | |
| desconto | Decimal(17,6) | Valor Desconto do item da Fatura. | |
| prazo_de_entrega | Data | Informar a data da previsão de entrega do item da Fatura. | |
| planoconta_id | Inteiro | ID do plano de contas do item da Fatura. |
GET https://open-api.eprom.com.br/api/Fatura/Item?id=123&documento_id=1332&produto_id=1332&planoconta_id=1332&descricao=1332&preco_unitario=15.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 18,
"data": [
{
"id": 11252,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 0,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11718,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 11625,
"sequencia": 1,
"descricao": "(65) Broca De Aco Rapido (h) 3/16\"",
"referencia": "017940",
"quantidade": 1,
"preco_unitario": 144,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 17940,
"descricao_reduzida": "(65) Broca De Aco Rapido (h)",
"descricao_completa": "(65) Broca De Aco Rapido (h) 3/16\""
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11599,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11597,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 11.88,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11592,
"sequencia": 1,
"descricao": "Caneta Bic",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 30,
"desconto": 0,
"frete": 10,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11574,
"sequencia": 1,
"descricao": "(65) Broca De Aco Rapido (e) 1/8",
"referencia": "018390",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 18390,
"descricao_reduzida": "(65) Broca De Aco Rapido (e)",
"descricao_completa": "(65) Broca De Aco Rapido (e) 1/8"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11559,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 10,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11388,
"sequencia": 1,
"descricao": "Poltrona",
"referencia": "013674",
"quantidade": 1,
"preco_unitario": 16.5,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 110,
"descricao_reduzida": "Poltrona",
"descricao_completa": "Poltrona"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11264,
"sequencia": 1,
"descricao": "Manutenção (07/2024)",
"referencia": null,
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": null,
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Itens FaturasGET/Fatura/Item{?id,documento_id,produto_id,planoconta_id,descricao,preco_unitario,page,size}
Lista Itens das Faturas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Fatura pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- planoconta_id
number(optional) Example: 1332Id do Plano de Contas. Poderá ser informado uma lista de valores separada por vírgula(,).
- produto_id
number(optional) Example: 1332Id do Produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: 1332Descrição ou parte da descrição.
- preco_unitario
number(optional) Example: 15.00Preço unitário. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Fatura/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"produto_id": "1",
"descricao": "Item 01",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"prazo_de_entrega": "2024-12-31",
"planoconta_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"produto_id": {
"type": "string",
"description": "ID do Produto."
},
"descricao": {
"type": "string",
"description": "Descrição do item da Fatura"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item da Fatura"
},
"preco_unitario": {
"type": "number",
"description": "Valor do item da Fatura"
},
"desconto": {
"type": "number",
"description": "Valor do item da Fatura"
},
"prazo_de_entrega": {
"type": "string"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item da Fatura"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11720,
"sequencia": 3,
"descricao": "Produto de Teste 01",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 200,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-10-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Item FaturaPUT/Fatura/Item/{id}
Processo de Alteração do item de uma Fatura.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | Inteiro | Informar o ID do produto da Fatura. | |
| descricao | Texto | Descrição da item da Fatura. | |
| quantidade | Decimal(17,6) | Quantidade do item da Fatura. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item da Fatura. | |
| desconto | Decimal(17,6) | Valor Desconto do item da Fatura. | |
| prazo_de_entrega | Data | Informar a data da previsão de entrega do item da Fatura. | |
| planoconta_id | Inteiro | ID do plano de contas do item da Fatura. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id do Item de Fatura
DELETE https://open-api.eprom.com.br/api/Fatura/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Item FaturaDELETE/Fatura/Item/{id}
Processo de Exclusão de um item de uma Fatura.
URI Parameters
- id
number(required) Example: 123Id do Item de Fatura
Faturas Parcelamento ¶
Endpoints relativos ao cadastro de dados de pagamento de uma Fatura.
POST https://open-api.eprom.com.br/api/Fatura/Parcelamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 4970,
"parcela": 1,
"vencimento": "2024-10-29",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Parcelamento FaturaPOST/Fatura/Parcelamento
Processo de Criação de uma pendência da Fatura. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID da Fatura. |
| parcela | ✔️ | Inteiro | Número da parcela. |
| vencimento | ✔️ | Data | Data de vencimento no formato AAAA-MM-DD. |
| valor | ✔️ | Numérico | Valor da parcela. |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
GET https://open-api.eprom.com.br/api/Fatura/Parcelamento?id=123&documento_id=1332&forma_pagto_id=1332&parcela=1&vencimento=2024-10-29&valor=150.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 199,
"data": [
{
"id": 164,
"parcela": 1,
"vencimento": "2020-03-12",
"valor": 200,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 300,
"parcela": 1,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 301,
"parcela": 2,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 302,
"parcela": 3,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 733,
"parcela": 1,
"vencimento": "2020-10-26",
"valor": 150,
"observacao": "fererereereer\r\n",
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
}
},
{
"id": 831,
"parcela": 1,
"vencimento": "2020-12-20",
"valor": 130.3,
"observacao": null,
"FormaPagamento": {
"id": 70,
"descricao": " TEST"
}
},
{
"id": 969,
"parcela": 1,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 970,
"parcela": 2,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1044,
"parcela": 1,
"vencimento": "2021-05-28",
"valor": 900,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1045,
"parcela": 2,
"vencimento": "2021-06-28",
"valor": 450,
"observacao": null,
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Parcelamento FaturasGET/Fatura/Parcelamento{?id,documento_id,forma_pagto_id,parcela,vencimento,valor,page,size}
Lista Parcelamento das Faturas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Fatura pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- forma_pagto_id
number(optional) Example: 1332Id da forma de pagamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- parcela
number(optional) Example: 1Número da parcela. Poderá ser informado uma lista de valores separada por vírgula(,).
- vencimento
string(optional) Example: 2024-10-29Data de vencimento. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- valor
number(optional) Example: 150.00Valor da parcela. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Fatura/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 123,
"parcela": 1,
"vencimento": "2024-10-30",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Parcelamento FaturaPUT/Fatura/Parcelamento/{id}
Processo de Alteração do parcelamento de uma Fatura.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Número da parcela. | |
| vencimento | Data | Data de vencimento no formato AAAA-MM-DD. | |
| valor | Numérico | Valor da parcela. | |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Parcela da Fatura
DELETE https://open-api.eprom.com.br/api/Fatura/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Parcelamento FaturaDELETE/Fatura/Parcelamento/{id}
Processo de Exclusão de um parcelamento de uma Fatura.
URI Parameters
- id
number(required) Example: 123Id da Parcela da Fatura
Documentos - Notas Emitidas ¶
Nesse grupo iremos trabalhar os documentos referentes a notas emitidas.
Notas Emitidas ¶
Endpoints relativos à Notas Emitidas.
POST https://open-api.eprom.com.br/api/NotaEmitida
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"incluir_produtos": "SIM",
"incluir_transportador": "SIM",
"itens": [
{
"nItem": 1,
"planoconta_id": 1,
"produto_id": 1
}
],
"xml": "<xml>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"incluir_produtos": {
"type": "string",
"enum": [
"SIM",
"NAO"
],
"description": "Incluir produtos?"
},
"incluir_transportador": {
"type": "string",
"enum": [
"SIM",
"NAO"
],
"description": "Incluir Transportadores?"
},
"itens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nItem": {
"type": "number",
"description": "Sequência do item do xml."
},
"planoconta_id": {
"type": "number",
"description": "Id do plano de contas do item."
},
"produto_id": {
"type": "number",
"description": "Id do produto."
}
}
},
"description": "Itens da Nota Fiscal emitida."
},
"xml": {
"type": "string",
"description": "XML do documento a ser importado."
}
},
"required": [
"xml"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7716,
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Notas Emitidas - Importação XMLsPOST/NotaEmitida
Processo de importação de Notas fiscais Emitidas. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| incluir_produtos | boolean | Informar true para cadastrar produtos, ou false para não cadastrar. |
|
| incluir_transportador | boolean | Informar true para cadastrar transportador, ou false para não cadastrar. |
|
| itens | TpItensNF[ ] | Conjunto de definições dos itens do documento. | |
| xml | ✔️ | String | XML do documento a ser importado. |
GET https://open-api.eprom.com.br/api/NotaEmitida?id=123&numero=1332&data_emissao=2025-03-01,2025-03-31&status=PENDENTE&cliente_id=1332&filial_id=1332&vendedor_id=1332&local_estoque_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 1,
"data": [
{
"id": 52,
"numero": 1,
"data_emissao": "2017-07-13T03:00:00.000Z",
"natureza_operacao": "VENDA",
"status": "CONCLUIDO",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 5450,
"nome": "Vendedor 1"
},
"Cliente": {
"id": 1411,
"nome": "Cliente 1"
},
"Filial": {
"id": 1,
"nome": "Empresa 1"
},
"LocalEstoque": null,
"Parcelamento": [
{
"id": 26,
"recebimento_id": null,
"parcela": 1,
"vencimento": "2017-08-01",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 27,
"recebimento_id": null,
"parcela": 2,
"vencimento": "2017-08-21",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
],
"Itens": [
{
"id": 50077,
"sequencia": 1,
"descricao": "CORREIA MUELLER PLUS SIMILAR N6",
"referencia": "3611",
"quantidade": 30,
"preco_unitario": 6.25,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": "cad_nfs#19951195|6.403$UN&",
"Produto": {
"id": 3611,
"descricao_reduzida": "Correia Tq. Mueller Pl",
"descricao_completa": "Correia Mueller Plus Similar N6"
},
"UnidadeMedida": {
"id": 16,
"sigla": "UN",
"descricao": "UN"
},
"PlanoConta": null
},
{
"id": 50078,
"sequencia": 2,
"descricao": "CORREIA MUELLER S POP ORIG",
"referencia": "4340",
"quantidade": 20,
"preco_unitario": 3.25,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": "cad_nfs#19951195|6.403$UN&",
"Produto": {
"id": 4340,
"descricao_reduzida": "Correia Mueller Super Pop Orig",
"descricao_completa": "Correia Mueller Super Pop Orig"
},
"UnidadeMedida": {
"id": 16,
"sigla": "UN",
"descricao": "UN"
},
"PlanoConta": null
},
]
},
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Notas Emitidas - ListarGET/NotaEmitida{?id,numero,data_emissao,status,cliente_id,filial_id,vendedor_id,local_estoque_id,page,size}
Lista Notas Fiscais Emitidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Nota Fiscal pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 2025-03-01,2025-03-31Data de emissão do documento a ser pesquisado. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTEEXPEDICAOPARALISADOCONCLUIDOFINALIZADOCANCELADO- cliente_id
number(optional) Example: 1332ID do cliente da NF. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
number(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- vendedor_id
number(optional) Example: 1332ID do vendedor. Poderá ser informado uma lista de valores separada por vírgula(,).
- local_estoque_id
number(optional) Example: 1332ID do local de estoque. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/NotaEmitida/Parcelamento?id=123&documento_id=1332&forma_pagto_id=1&recebimento_id=1&parcela=1332&vencimento=2025-03-01,2025-03-30&valor=100.00,200.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 26723,
"data": [
{
"id": 26,
"recebimento_id": null,
"parcela": 1,
"vencimento": "2017-08-01",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 27,
"recebimento_id": null,
"parcela": 2,
"vencimento": "2017-08-21",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 28,
"recebimento_id": null,
"parcela": 3,
"vencimento": "2017-09-08",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 29,
"recebimento_id": null,
"parcela": 4,
"vencimento": "2017-09-29",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 30,
"recebimento_id": null,
"parcela": 5,
"vencimento": "2017-10-20",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 4,
"recebimento_id": null,
"parcela": 1,
"vencimento": "2017-08-11",
"valor": 285.39,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 5,
"recebimento_id": null,
"parcela": 2,
"vencimento": "2017-09-12",
"valor": 285.38,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 6,
"recebimento_id": null,
"parcela": 3,
"vencimento": "2017-10-11",
"valor": 285.38,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 12,
"recebimento_id": null,
"parcela": 1,
"vencimento": "2017-08-11",
"valor": 125.32,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 13,
"recebimento_id": null,
"parcela": 2,
"vencimento": "2017-09-12",
"valor": 125.34,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Notas Emitidas - ParcelamentosGET/NotaEmitida/Parcelamento{?id,documento_id,forma_pagto_id,recebimento_id,parcela,vencimento,valor,page,size}
Lista os parcelamentos das Notas Fiscais Emitidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a o parcelamento pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Número do documento do parcelamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- forma_pagto_id
number(optional) Example: 1Se informado o id, buscará os parcelamentos pelo id da forma de pagamento escolhida. Poderá ser informado uma lista de valores separada por vírgula(,).
- recebimento_id
number(optional) Example: 1Se informado o id, buscará os parcelamentos pelo id do recebimento. Poderá ser informado uma lista de valores separada por vírgula(,).
- parcela
number(optional) Example: 1332Se informado a parcela, buscará os parcelamentos pelo número da parcela. Poderá ser informado uma lista de valores separada por vírgula(,).
- vencimento
string(optional) Example: 2025-03-01,2025-03-30Data de vencimento das parcelas a serem pesquisadas. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- valor
string(optional) Example: 100.00,200.00Valores das parcelas a serem pesquisadas. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
Documentos - Notas Recebidas ¶
Nesse grupo iremos trabalhar os documentos referentes a notas recebidas.
Notas Recebidas ¶
Endpoints relativos à Notas Recebidas.
POST https://open-api.eprom.com.br/api/NotaRecebida
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"incluir_produtos": "SIM",
"incluir_transportador": "SIM",
"itens": [
{
"nItem": 1,
"planoconta_id": 1,
"produto_id": 1
}
],
"xml": "<xml>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"incluir_produtos": {
"type": "string",
"enum": [
"SIM",
"NAO"
],
"description": "Incluir produtos?"
},
"incluir_transportador": {
"type": "string",
"enum": [
"SIM",
"NAO"
],
"description": "Incluir Transportadores?"
},
"itens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nItem": {
"type": "number",
"description": "Sequência do item do xml."
},
"planoconta_id": {
"type": "number",
"description": "Id do plano de contas do item."
},
"produto_id": {
"type": "number",
"description": "Id do produto."
}
}
},
"description": "Itens da Nota Fiscal recebidas."
},
"xml": {
"type": "string",
"description": "XML do documento a ser importado."
}
},
"required": [
"xml"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7716,
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Notas Recebidas - Importação XMLsPOST/NotaRecebida
Processo de importação de Notas fiscais Emitidas. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| incluir_produtos | boolean | Informar true para cadastrar produtos, ou false para não cadastrar. |
|
| incluir_transportador | boolean | Informar true para cadastrar transportador, ou false para não cadastrar. |
|
| itens | TpItensNF[ ] | Conjunto de definições dos itens do documento. | |
| xml | ✔️ | String | XML do documento a ser importado. |
Tipos de dados usados:
Tipo dados dos itens da Nota Fiscal Emitida/Recebidas
TpItensNF
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
nItem
Inteiro
Sequência do item do xml.
planoconta_id
Inteiro
Id do plano de contas do item.
produto_id
Inteiro
Id do produto.
TpItensNF
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| nItem | Inteiro | Sequência do item do xml. | |
| planoconta_id | Inteiro | Id do plano de contas do item. | |
| produto_id | Inteiro | Id do produto. |
GET https://open-api.eprom.com.br/api/NotaRecebida?id=123&numero=1332&data_emissao=2025-03-01,2025-03-31&data_entrada=2025-03-01,2025-03-31&status=PENDENTE&fornecedor_id=1332&filial_id=1332&local_estoque_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 1,
"data": [
{
"id": 52,
"numero": 1,
"data_emissao": "2017-07-13T03:00:00.000Z",
"natureza_operacao": "VENDA",
"status": "CONCLUIDO",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 5450,
"nome": "Vendedor 1"
},
"Cliente": {
"id": 1411,
"nome": "Cliente 1"
},
"Filial": {
"id": 1,
"nome": "Empresa 1"
},
"LocalEstoque": null,
"Parcelamento": [
{
"id": 26,
"recebimento_id": null,
"parcela": 1,
"vencimento": "2017-08-01",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 27,
"recebimento_id": null,
"parcela": 2,
"vencimento": "2017-08-21",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
],
"Itens": [
{
"id": 50077,
"sequencia": 1,
"descricao": "CORREIA MUELLER PLUS SIMILAR N6",
"referencia": "3611",
"quantidade": 30,
"preco_unitario": 6.25,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": "cad_nfs#19951195|6.403$UN&",
"Produto": {
"id": 3611,
"descricao_reduzida": "Correia Tq. Mueller Pl",
"descricao_completa": "Correia Mueller Plus Similar N6"
},
"UnidadeMedida": {
"id": 16,
"sigla": "UN",
"descricao": "UN"
},
"PlanoConta": null
},
{
"id": 50078,
"sequencia": 2,
"descricao": "CORREIA MUELLER S POP ORIG",
"referencia": "4340",
"quantidade": 20,
"preco_unitario": 3.25,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": "cad_nfs#19951195|6.403$UN&",
"Produto": {
"id": 4340,
"descricao_reduzida": "Correia Mueller Super Pop Orig",
"descricao_completa": "Correia Mueller Super Pop Orig"
},
"UnidadeMedida": {
"id": 16,
"sigla": "UN",
"descricao": "UN"
},
"PlanoConta": null
},
]
},
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Notas Recebidas - ListarGET/NotaRecebida{?id,numero,data_emissao,data_entrada,status,fornecedor_id,filial_id,local_estoque_id,page,size}
Lista Notas Fiscais Recebidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Nota Fiscal pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 2025-03-01,2025-03-31Data de emissão do documento a ser pesquisado. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- data_entrada
string(optional) Example: 2025-03-01,2025-03-31Data de entrada do documento a ser pesquisado. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTEEXPEDICAOPARALISADOCONCLUIDOFINALIZADOCANCELADO- fornecedor_id
number(optional) Example: 1332ID do fornecedor da NF. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
number(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- local_estoque_id
number(optional) Example: 1332ID do local de estoque. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/NotaRecebida/Parcelamento?id=123&documento_id=1332&forma_pagto_id=1&pagamento_id=1&parcela=1332&vencimento=2025-03-01,2025-03-30&valor=100.00,200.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 26723,
"data": [
{
"id": 26,
"pagamento_id": null,
"parcela": 1,
"vencimento": "2017-08-01",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 27,
"pagamento_id": null,
"parcela": 2,
"vencimento": "2017-08-21",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 28,
"pagamento_id": null,
"parcela": 3,
"vencimento": "2017-09-08",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 29,
"pagamento_id": null,
"parcela": 4,
"vencimento": "2017-09-29",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 30,
"pagamento_id": null,
"parcela": 5,
"vencimento": "2017-10-20",
"valor": 1101.13,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 4,
"pagamento_id": null,
"parcela": 1,
"vencimento": "2017-08-11",
"valor": 285.39,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 5,
"pagamento_id": null,
"parcela": 2,
"vencimento": "2017-09-12",
"valor": 285.38,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 6,
"pagamento_id": null,
"parcela": 3,
"vencimento": "2017-10-11",
"valor": 285.38,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 12,
"pagamento_id": null,
"parcela": 1,
"vencimento": "2017-08-11",
"valor": 125.32,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
},
{
"id": 13,
"pagamento_id": null,
"parcela": 2,
"vencimento": "2017-09-12",
"valor": 125.34,
"observacao": null,
"FormaPagamento": {
"id": 37,
"descricao": "BOLETO"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Notas Recebidas - ParcelamentosGET/NotaRecebida/Parcelamento{?id,documento_id,forma_pagto_id,pagamento_id,parcela,vencimento,valor,page,size}
Lista os parcelamentos das Notas Fiscais Recebidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a o parcelamento pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Número do documento do parcelamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- forma_pagto_id
number(optional) Example: 1Se informado o id, buscará os parcelamentos pelo id da forma de pagamento escolhida. Poderá ser informado uma lista de valores separada por vírgula(,).
- pagamento_id
number(optional) Example: 1Se informado o id, buscará os parcelamentos pelo id do pagamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- parcela
number(optional) Example: 1332Se informado a parcela, buscará os parcelamentos pelo número da parcela. Poderá ser informado uma lista de valores separada por vírgula(,).
- vencimento
string(optional) Example: 2025-03-01,2025-03-30Data de vencimento das parcelas a serem pesquisadas. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- valor
string(optional) Example: 100.00,200.00Valores das parcelas a serem pesquisadas. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
Documentos - Pedidos de Venda ¶
Nesse grupo iremos trabalhar os documentos referentes a pedidos de vendas.
Pedido Vendas ¶
Endpoints relativos à Pedido Vendas.
POST https://open-api.eprom.com.br/api/PedidoVenda
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"numero": 123456,
"data_emissao": "2024-10-30 09:01:04",
"filial_id": 125,
"cliente_id": 125,
"vendedor_id": 1,
"local_estoque_id": 1,
"endereco_entrega_id": 1,
"frete": 150,
"observacao": "Observação de teste",
"Itens": [
{
"produto_id": "1",
"descricao": "Item 01",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"prazo_entrega": "2024-12-31",
"planoconta_id": 1
}
],
"Pagamentos": [
{
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"forma_pagto_id": 1,
"observacao": "OBS teste"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"numero": {
"type": "number",
"description": "Número do Pedido Vendas"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão do Pedido Vendas"
},
"filial_id": {
"type": "number",
"description": "ID da Filial do Pedido Vendas."
},
"cliente_id": {
"type": "number",
"description": "ID do Cliente do Pedido Vendas."
},
"vendedor_id": {
"type": "number",
"description": "ID do vendedor do Pedido Vendas."
},
"local_estoque_id": {
"type": "number",
"description": "ID do local de estoque."
},
"endereco_entrega_id": {
"type": "number",
"description": "ID do local de entrega do Pedido Vendas."
},
"frete": {
"type": "number",
"description": "Valor do frete."
},
"observacao": {
"type": "string",
"description": "Observação do Pedido Vendas."
},
"Itens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"produto_id": {
"type": "string",
"description": "ID do Produto."
},
"descricao": {
"type": "string",
"description": "Descrição do item do Pedido Vendas"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item do Pedido Vendas"
},
"preco_unitario": {
"type": "number",
"description": "Valor do item do Pedido Vendas"
},
"desconto": {
"type": "number",
"description": "Valor do item do Pedido Vendas"
},
"prazo_entrega": {
"type": "string"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item do Pedido Vendas"
}
}
},
"description": "Itens do Pedido Vendas"
},
"Pagamentos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parcela": {
"type": "number",
"description": "Número da parcela."
},
"vencimento": {
"type": "string",
"description": "Data de vencimento."
},
"valor": {
"type": "number",
"description": "Valor da parcela."
},
"forma_pagto_id": {
"type": "number",
"description": "ID da forma de pagamento da parcela."
},
"observacao": {
"type": "string",
"description": "Observação da parcela"
}
}
},
"description": "Parcelas do Pedido Vendas"
}
},
"required": [
"cliente_id",
"vendedor_id",
"local_estoque_id",
"endereco_entrega_id",
"frete",
"Itens",
"Pagamentos"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7716,
"numero": 123456,
"data_emissao": "2024-10-30T14:40:15.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11718,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 11719,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 100,
"desconto": 0,
"frete": 125,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
],
"Pagamentos": [
{
"id": 4977,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4978,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Pedido VendasPOST/PedidoVenda
Processo de Criação de um Pedido Vendas. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão do Pedido Vendas. Formato 2024-10-20 23:53:51. | |
| filial_id | Inteiro | Informar o ID da Filial do Pedido Vendas de Mercadoria. | |
| cliente_id | ✔️ | Inteiro | Informar o ID do Cliente referete ao Pedido Vendas. |
| vendedor_id | Inteiro | Informar o ID do Vendedor referete ao Pedido Vendas. | |
| local_estoque_id | Inteiro | Informar o ID do local de estoque referete ao Pedido Vendas. | |
| endereco_entrega_id | Inteiro | Informar o ID do endereço de entrega do Pedido Vendas. | |
| frete | Número | Informar o valor do frete. | |
| observacao | Texto | Informar a Observação do Pedido Vendas. | |
| Itens | ✔️ | TipoDocPedidoVendasItem[ ] | Conjunto de Itens do Pedido Vendas de Mercadoria. |
| Pagamentos | ✔️ | TipoDocPedidoVendasPag[ ] | Conjunto de dados referente ao Pagamento do Pedido Vendas de Mercadoria. |
Tipos de dados usados:
Itens de um Pedido Vendas
TipoDocPedidoVendasItem
Os campos que compõem um item são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
produto_id
Inteiro
Informar o ID do produto do Pedido Vendas.
descricao
Texto
Descrição da item do Pedido Vendas.
quantidade
Decimal(17,6)
Quantidade do item do Pedido Vendas.
preco_unitario
Decimal(17,6)
Valor Unitário do item do Pedido Vendas.
desconto
Decimal(17,6)
Valor Desconto do item do Pedido Vendas.
prazo_entrega
Data
Informar a data da previsão de entrega do item do Pedido Vendas.
planoconta_id
Inteiro
ID do plano de contas do item do Pedido Vendas.
TipoDocPedidoVendasItem
Os campos que compõem um item são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | Inteiro | Informar o ID do produto do Pedido Vendas. | |
| descricao | Texto | Descrição da item do Pedido Vendas. | |
| quantidade | Decimal(17,6) | Quantidade do item do Pedido Vendas. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item do Pedido Vendas. | |
| desconto | Decimal(17,6) | Valor Desconto do item do Pedido Vendas. | |
| prazo_entrega | Data | Informar a data da previsão de entrega do item do Pedido Vendas. | |
| planoconta_id | Inteiro | ID do plano de contas do item do Pedido Vendas. |
Itens de um pagamento de um Pedido Vendas
TipoDocPedidoVendasPag
Os campos que compõem uma parcela de um pagamento de um Pedido Vendas são descritos abaixo:
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
parcela
Inteiro
Informar o número da parcela.
vencimento
Data
Informar a data de vencimento da parcela.
valor
Decimal(15,2)
Informar o valor da parcela.
forma_pagto_id
Inteiro
Informar o ID da forma de pagamento da parcela.
observacao
String(50)
Informar a observação da parcela.
TipoDocPedidoVendasPag
Os campos que compõem uma parcela de um pagamento de um Pedido Vendas são descritos abaixo:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Informar o número da parcela. | |
| vencimento | Data | Informar a data de vencimento da parcela. | |
| valor | Decimal(15,2) | Informar o valor da parcela. | |
| forma_pagto_id | Inteiro | Informar o ID da forma de pagamento da parcela. | |
| observacao | String(50) | Informar a observação da parcela. |
GET https://open-api.eprom.com.br/api/PedidoVenda?id=123&numero=1332&data_emissao=2024-10-01&status=PENDENTE&situacao=ENVIADO&cliente_id=1332&filial_id=1332&vendedor_id=1332&local_estoque_id=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 12,
"data": [
{
"id": 7380,
"numero": null,
"data_emissao": "2024-07-12T19:01:12.000Z",
"status": "CONCLUIDO",
"observacao": "",
"Origem": {
"id": 7373,
"tipo": "ORDEM DE SERVIÇO - SERVICOS",
"numero": null
},
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 430,
"nome": "Tiago Fontes Saggioro"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": [
{
"id": 11236,
"sequencia": 1,
"descricao": "Manutenção",
"referencia": null,
"quantidade": 1,
"preco_unitario": 15,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": null,
"UnidadeMedida": null,
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
}
]
},
{
"id": 7389,
"numero": null,
"data_emissao": "2024-07-19T20:09:52.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": {
"id": 55823,
"uf": "SP",
"cep": "17203-480",
"pais": "BRASIL",
"bairro": "Jardim Estadio",
"cidade": "JAU",
"numero": "55823",
"logradouro": "Rua Angelo Martins",
"codigo_ibge": 3525300,
"complemento": null,
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
}
},
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 51833,
"nome": "Aaron Baccili Masiero Linares"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4877,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4878,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 300,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11252,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 0,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7395,
"numero": null,
"data_emissao": "2024-07-30T11:53:52.000Z",
"status": "CONCLUIDO",
"observacao": "",
"Origem": {
"id": 7383,
"tipo": "ORDEM DE SERVIÇO - SERVICOS",
"numero": null
},
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": [
{
"id": 11264,
"sequencia": 1,
"descricao": "Manutenção (07/2024)",
"referencia": null,
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": null,
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
},
{
"id": 11265,
"sequencia": 2,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
},
{
"id": 11266,
"sequencia": 3,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
},
{
"id": 11267,
"sequencia": 4,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
}
]
},
{
"id": 7454,
"numero": null,
"data_emissao": "2024-08-06T17:59:38.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 27,
"nome": "Agonezi Murillo Amato"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": []
},
{
"id": 7485,
"numero": null,
"data_emissao": "2024-08-16T14:59:29.000Z",
"status": "CONCLUIDO",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 10254,
"nome": "Aldine Malaspina Eprom"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4756,
"parcela": 1,
"vencimento": "2024-09-15",
"valor": 16.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
],
"Itens": [
{
"id": 11388,
"sequencia": 1,
"descricao": "Poltrona",
"referencia": "013674",
"quantidade": 1,
"preco_unitario": 16.5,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 110,
"descricao_reduzida": "Poltrona",
"descricao_completa": "Poltrona"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7608,
"numero": null,
"data_emissao": "2024-10-02T17:22:58.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 98188,
"nome": "entidade teste"
},
"Cliente": {
"id": 51833,
"nome": "Aaron Baccili Masiero Linares"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4811,
"parcela": 1,
"vencimento": "2024-10-02",
"valor": 5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 4812,
"parcela": 2,
"vencimento": "2024-10-12",
"valor": 5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
}
],
"Itens": [
{
"id": 11559,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 10,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7621,
"numero": null,
"data_emissao": "2024-10-04T13:05:47.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 11622,
"nome": "Abadias Sparapan Jesuslima"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [],
"Itens": [
{
"id": 11574,
"sequencia": 1,
"descricao": "(65) Broca De Aco Rapido (e) 1/8",
"referencia": "018390",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 18390,
"descricao_reduzida": "(65) Broca De Aco Rapido (e)",
"descricao_completa": "(65) Broca De Aco Rapido (e) 1/8"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7636,
"numero": null,
"data_emissao": "2024-10-09T13:32:15.000Z",
"status": "PENDENTE",
"observacao": null,
"Origem": {
"id": 6562,
"tipo": "PEDIDO DE VENDA - VENDA",
"numero": 27
},
"EnderecoEntrega": null,
"Vendedor": {
"id": 27,
"nome": "Agonezi Murillo Amato"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": null,
"Pagamentos": [
{
"id": 4886,
"parcela": 1,
"vencimento": "2024-11-08",
"valor": 131.57,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4887,
"parcela": 2,
"vencimento": "2024-12-08",
"valor": 59.48,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4888,
"parcela": 3,
"vencimento": "2025-01-07",
"valor": 59.48,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4889,
"parcela": 4,
"vencimento": "2025-02-06",
"valor": 59.47,
"observacao": null,
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11592,
"sequencia": 1,
"descricao": "Caneta Bic",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 30,
"desconto": 0,
"frete": 10,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7641,
"numero": 123456,
"data_emissao": "2024-10-09T17:20:14.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Pagamentos": [
{
"id": 4848,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 13.64,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4849,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 13.64,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11597,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 11.88,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11598,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 3.08,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
},
{
"id": 7642,
"numero": 12345678,
"data_emissao": "2024-10-09T17:20:59.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Pagamentos": [
{
"id": 4850,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4851,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
],
"Itens": [
{
"id": 11599,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11600,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 100,
"desconto": 0,
"frete": 125,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Pedido VendasGET/PedidoVenda{?id,numero,data_emissao,status,situacao,cliente_id,filial_id,vendedor_id,local_estoque_id,page,size}
Lista Pedido Vendas de mercadorias.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Pedido Vendas pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- numero
number(optional) Example: 1332Número do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- data_emissao
string(optional) Example: 2024-10-01Data de emissão do Pedido Vendas. Poderá ser informado o valor inicio, e o valor fim, para isso separar os valores por vírgula(,).
- status
string(optional) Example: PENDENTEStatus do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
Choices:
PENDENTECONCLUIDOCANCELADO- situacao
string(optional) Example: ENVIADOSituação do documento. Poderá ser informado uma lista de valores separada por vírgula(,). As situações são as descrições constantes nos status do documento do sistema.
- cliente_id
number(optional) Example: 1332ID do fornecedor do Pedido Vendas. Poderá ser informado uma lista de valores separada por vírgula(,).
- filial_id
string(optional) Example: 1332ID da Filial. Poderá ser informado uma lista de valores separada por vírgula(,).
- vendedor_id
string(optional) Example: 1332ID do Vendedor. Poderá ser informado uma lista de valores separada por vírgula(,).
- local_estoque_id
string(optional) Example: 1332ID do local do estoque. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/PedidoVenda/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"numero": 123456,
"data_emissao": "2024-10-30 09:01:04",
"filial_id": 125,
"cliente_id": 125,
"vendedor_id": 1,
"local_estoque_id": 1,
"endereco_entrega_id": 1,
"frete": 150,
"observacao": "Observação de teste"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"numero": {
"type": "number",
"description": "Número do Pedido Vendas"
},
"data_emissao": {
"type": "string",
"description": "Data hora da Emissão do Pedido Vendas"
},
"filial_id": {
"type": "number",
"description": "ID da Filial do Pedido Vendas."
},
"cliente_id": {
"type": "number",
"description": "ID do Cliente do Pedido Vendas."
},
"vendedor_id": {
"type": "number",
"description": "ID do vendedor do Pedido Vendas."
},
"local_estoque_id": {
"type": "number",
"description": "ID do local de estoque."
},
"endereco_entrega_id": {
"type": "number",
"description": "ID do local de entrega do Pedido Vendas."
},
"frete": {
"type": "number",
"description": "Valor do frete."
},
"observacao": {
"type": "string",
"description": "Observação do Pedido Vendas."
}
},
"required": [
"cliente_id",
"vendedor_id",
"local_estoque_id",
"endereco_entrega_id",
"frete"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 7716,
"numero": 12345678,
"data_emissao": "2024-10-30T14:40:15.000Z",
"status": "PENDENTE",
"observacao": "Observação de teste",
"Origem": null,
"EnderecoEntrega": null,
"Vendedor": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Cliente": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"Filial": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"LocalEstoque": {
"id": 1,
"local": "ALMOX\r\n",
"descricao": "ALMOXARIFADO"
},
"Itens": [
{
"id": 11718,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 11719,
"sequencia": 2,
"descricao": "Item 02",
"referencia": "000002",
"quantidade": 5,
"preco_unitario": 100,
"desconto": 0,
"frete": 125,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 2,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
],
"Pagamentos": [
{
"id": 4977,
"parcela": 1,
"vencimento": "2024-10-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
},
{
"id": 4978,
"parcela": 2,
"vencimento": "2024-11-03",
"valor": 375,
"observacao": "OBS teste",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Pedido VendasPUT/PedidoVenda/{id}
Processo de Alteração de um Pedido Vendas.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| numero | Inteiro | Informar o número do documento. | |
| data_emissao | Data Hora | Informar a data hora da emissão do Pedido Vendas. Formato 2024-10-20 23:53:51. | |
| filial_id | Inteiro | Informar o ID da Filial do Pedido Vendas de Mercadoria. | |
| cliente_id | Inteiro | Informar o ID do Cliente referete a Pedido Vendas. | |
| vendedor_id | Inteiro | Informar o ID do Vendedor referete a Pedido Vendas. | |
| local_estoque_id | Inteiro | Informar o ID do local de estoque referete a Pedido Vendas. | |
| endereco_entrega_id | Inteiro | Informar o ID do endereço de entrega do Pedido Vendas. | |
| frete | Número | Informar o valor do frete. | |
| observacao | Texto | Informar a Observação do Pedido Vendas. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id do Pedido Vendas
DELETE https://open-api.eprom.com.br/api/PedidoVenda/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Documento excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Pedido VendasDELETE/PedidoVenda/{id}
Processo de Exclusão do Pedido Vendas.
URI Parameters
- id
number(required) Example: 123Id do Pedido Vendas
Pedido Itens ¶
Endpoints relativos ao cadastro de itens de um Pedido.
POST https://open-api.eprom.com.br/api/PedidoVenda/Item
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11720,
"sequencia": 3,
"descricao": "Produto de Teste 01",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-10-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Item PedidoPOST/PedidoVenda/Item
Processo de Criação de itens de um Pedido. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID do Pedido. |
| produto_id | Inteiro | Informar o ID do produto do Pedido. | |
| descricao | Texto | Descrição da item do Pedido. | |
| quantidade | Decimal(17,6) | Quantidade do item do Pedido. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item do Pedido. | |
| desconto | Decimal(17,6) | Valor Desconto do item do Pedido. | |
| prazo_de_entrega | Data | Informar a data da previsão de entrega do item do Pedido. | |
| planoconta_id | Inteiro | ID do plano de contas do item do Pedido. |
GET https://open-api.eprom.com.br/api/PedidoVenda/Item?id=123&documento_id=1332&produto_id=1332&planoconta_id=1332&descricao=1332&preco_unitario=15.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 18,
"data": [
{
"id": 11252,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 0,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11718,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
},
{
"id": 11625,
"sequencia": 1,
"descricao": "(65) Broca De Aco Rapido (h) 3/16\"",
"referencia": "017940",
"quantidade": 1,
"preco_unitario": 144,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 17940,
"descricao_reduzida": "(65) Broca De Aco Rapido (h)",
"descricao_completa": "(65) Broca De Aco Rapido (h) 3/16\""
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11599,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 25,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11597,
"sequencia": 1,
"descricao": "Item 01",
"referencia": "000001",
"quantidade": 1,
"preco_unitario": 11.88,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-12-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11592,
"sequencia": 1,
"descricao": "Caneta Bic",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 30,
"desconto": 0,
"frete": 10,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11574,
"sequencia": 1,
"descricao": "(65) Broca De Aco Rapido (e) 1/8",
"referencia": "018390",
"quantidade": 1,
"preco_unitario": 0,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 18390,
"descricao_reduzida": "(65) Broca De Aco Rapido (e)",
"descricao_completa": "(65) Broca De Aco Rapido (e) 1/8"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11559,
"sequencia": 1,
"descricao": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi",
"referencia": "019620",
"quantidade": 1,
"preco_unitario": 10,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 19620,
"descricao_reduzida": "(61) Plug Macho Triangulo Ci",
"descricao_completa": "(61) Plug Macho Triangulo Cinza 2p 10a Ilumi"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11388,
"sequencia": 1,
"descricao": "Poltrona",
"referencia": "013674",
"quantidade": 1,
"preco_unitario": 16.5,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": {
"id": 110,
"descricao_reduzida": "Poltrona",
"descricao_completa": "Poltrona"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": null
},
{
"id": 11264,
"sequencia": 1,
"descricao": "Manutenção (07/2024)",
"referencia": null,
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": null,
"observacao": null,
"Produto": null,
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 270,
"conta": "3.01.01.01.01.01.02",
"descricao": "Receita De Vendas De Mercadorias E Produtos A Comercial Exportadora Com Fim Fim Fim Fim"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Itens PedidosGET/PedidoVenda/Item{?id,documento_id,produto_id,planoconta_id,descricao,preco_unitario,page,size}
Lista Itens das Pedidos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Pedido pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- planoconta_id
number(optional) Example: 1332Id do Plano de Contas. Poderá ser informado uma lista de valores separada por vírgula(,).
- produto_id
number(optional) Example: 1332Id do Produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: 1332Descrição ou parte da descrição.
- preco_unitario
number(optional) Example: 15.00Preço unitário. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/PedidoVenda/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"produto_id": "1",
"descricao": "Item 01",
"quantidade": 1,
"preco_unitario": 100,
"desconto": 0,
"prazo_de_entrega": "2024-12-31",
"planoconta_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"produto_id": {
"type": "string",
"description": "ID do Produto."
},
"descricao": {
"type": "string",
"description": "Descrição do item do Pedido"
},
"quantidade": {
"type": "number",
"description": "Quantidade do item do Pedido"
},
"preco_unitario": {
"type": "number",
"description": "Valor do item do Pedido"
},
"desconto": {
"type": "number",
"description": "Valor do item do Pedido"
},
"prazo_de_entrega": {
"type": "string"
},
"planoconta_id": {
"type": "number",
"description": "ID do plano de contas do item do Pedido"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 11720,
"sequencia": 3,
"descricao": "Produto de Teste 01",
"referencia": "000001",
"quantidade": 10,
"preco_unitario": 200,
"desconto": 0,
"frete": 0,
"seguro": 0,
"despesas_acessorias": 0,
"eventuais": 0,
"outros_valores": 0,
"prazo_de_entrega": "2024-10-31",
"observacao": null,
"Produto": {
"id": 1,
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic"
},
"UnidadeMedida": {
"id": 1,
"sigla": "UNID",
"descricao": "UNIDADE"
},
"PlanoConta": {
"id": 1,
"conta": "1",
"descricao": "Ativo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Item PedidoPUT/PedidoVenda/Item/{id}
Processo de Alteração do item de um Pedido.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | Inteiro | Informar o ID do produto do Pedido. | |
| descricao | Texto | Descrição da item do Pedido. | |
| quantidade | Decimal(17,6) | Quantidade do item do Pedido. | |
| preco_unitario | Decimal(17,6) | Valor Unitário do item do Pedido. | |
| desconto | Decimal(17,6) | Valor Desconto do item do Pedido. | |
| prazo_de_entrega | Data | Informar a data da previsão de entrega do item do Pedido. | |
| planoconta_id | Inteiro | ID do plano de contas do item do Pedido. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id do Item de Pedido
DELETE https://open-api.eprom.com.br/api/PedidoVenda/Item/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Item PedidoDELETE/PedidoVenda/Item/{id}
Processo de Exclusão de um item de um Pedido.
URI Parameters
- id
number(required) Example: 123Id do Item de Pedido
Pedidos Parcelamento ¶
Endpoints relativos ao cadastro de dados de pagamento de um Pedido.
POST https://open-api.eprom.com.br/api/PedidoVenda/Parcelamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 4970,
"parcela": 1,
"vencimento": "2024-10-29",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Parcelamento PedidoPOST/PedidoVenda/Parcelamento
Processo de Criação de uma pendência do Pedido. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento_id | ✔️ | Inteiro | ID do Pedido. |
| parcela | ✔️ | Inteiro | Número da parcela. |
| vencimento | ✔️ | Data | Data de vencimento no formato AAAA-MM-DD. |
| valor | ✔️ | Numérico | Valor da parcela. |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
GET https://open-api.eprom.com.br/api/PedidoVenda/Parcelamento?id=123&documento_id=1332&forma_pagto_id=1332&parcela=1&vencimento=2024-10-29&valor=150.00&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 199,
"data": [
{
"id": 164,
"parcela": 1,
"vencimento": "2020-03-12",
"valor": 200,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 300,
"parcela": 1,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 301,
"parcela": 2,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 302,
"parcela": 3,
"vencimento": "2020-07-02",
"valor": 105,
"observacao": null,
"FormaPagamento": {
"id": 4,
"descricao": "DINHEIRO - Pagar"
}
},
{
"id": 733,
"parcela": 1,
"vencimento": "2020-10-26",
"valor": 150,
"observacao": "fererereereer\r\n",
"FormaPagamento": {
"id": 13,
"descricao": "DEPOSITO"
}
},
{
"id": 831,
"parcela": 1,
"vencimento": "2020-12-20",
"valor": 130.3,
"observacao": null,
"FormaPagamento": {
"id": 70,
"descricao": " TEST"
}
},
{
"id": 969,
"parcela": 1,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 970,
"parcela": 2,
"vencimento": "2021-04-08",
"valor": 582.5,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1044,
"parcela": 1,
"vencimento": "2021-05-28",
"valor": 900,
"observacao": null,
"FormaPagamento": {
"id": 3,
"descricao": "BOLETO BANCÁRIO"
}
},
{
"id": 1045,
"parcela": 2,
"vencimento": "2021-06-28",
"valor": 450,
"observacao": null,
"FormaPagamento": {
"id": 16,
"descricao": "BANCO ITAU"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Parcelamento PedidosGET/PedidoVenda/Parcelamento{?id,documento_id,forma_pagto_id,parcela,vencimento,valor,page,size}
Lista Parcelamento das Pedidos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Pedido pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento_id
number(optional) Example: 1332Id do documento. Poderá ser informado uma lista de valores separada por vírgula(,).
- forma_pagto_id
number(optional) Example: 1332Id da forma de pagamento. Poderá ser informado uma lista de valores separada por vírgula(,).
- parcela
number(optional) Example: 1Número da parcela. Poderá ser informado uma lista de valores separada por vírgula(,).
- vencimento
string(optional) Example: 2024-10-29Data de vencimento. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- valor
number(optional) Example: 150.00Valor da parcela. Poderá ser informado o valor inicial e o final, separados por vírgula (,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/PedidoVenda/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 123,
"parcela": 1,
"vencimento": "2024-10-30",
"valor": 100,
"observacao": "obs da parcela",
"FormaPagamento": {
"id": 1,
"descricao": "DINHEIRO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Parcelamento PedidoPUT/PedidoVenda/Parcelamento/{id}
Processo de Alteração do parcelamento de um Pedido.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| parcela | Inteiro | Número da parcela. | |
| vencimento | Data | Data de vencimento no formato AAAA-MM-DD. | |
| valor | Numérico | Valor da parcela. | |
| forma_pagto_id | Inteiro | ID da forma de pagamento. | |
| observacao | Texto | Texto da Observação. |
Esse endpoint se obtiver succeso na alteração retorná os dados do Documento registrado com as alterações.
URI Parameters
- id
number(required) Example: 123Id da Parcela do Pedido
DELETE https://open-api.eprom.com.br/api/PedidoVenda/Parcelamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Parcelamento PedidoDELETE/PedidoVenda/Parcelamento/{id}
Processo de Exclusão de um parcelamento de um Pedido.
URI Parameters
- id
number(required) Example: 123Id da Parcela do Pedido
Entidades ¶
Nesse grupo iremos trabalhar todos os itens de cadastro do sistema.
Entidade ¶
Endpoints relativos ao cadastro de entidades (Clientes, Fornecedores, Transportadores, Vendedores).
POST https://open-api.eprom.com.br/api/Entidade
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"codigo": 1234,
"pessoa": "FISICA",
"nome": "Nome da Entidade",
"fantasia": "Nome da Fantasia",
"atividade_entidade_id": 499,
"Documentos": [
{
"documento": "12.345.678/0001-12",
"tipo_documento_id": 1
}
],
"Contatos": [
{
"conteudo": "(14) 12345-1234",
"tipo_contato_id": 1
}
],
"Enderecos": [
{
"cep": "12346978",
"logradouro": "Rua das Ruas",
"numero": "KM 123",
"bairro": "VILA AZUL",
"codigo_ibge": 1234,
"complemento": "complemento",
"tipo_endereco_id": 1
}
],
"Tipos": [
"CLIENTE"
]
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-post.defs.json",
"type": "object",
"additionalProperties": false,
"properties": {
"codigo": {
"type": "integer",
"description": "Código definido pela empresa"
},
"pessoa": {
"$ref": "ent-post.defs.json#/definitions/tipo_pessoa"
},
"nome": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Nome da Entidade"
},
"fantasia": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Nome da Entidade"
},
"atividade_entidade_id": {
"type": "integer",
"description": "Id da Atividade comercial da Entidade. Consultar Atividades Comerciais para obter o Id."
},
"sexo": {
"$ref": "ent-post.defs.json#/definitions/tipo_sexo"
},
"dtnasc": {
"type": "string",
"format": "date",
"description": "Data de Nascimento"
},
"estado_civil": {
"$ref": "ent-post.defs.json#/definitions/tipo_estado_civil"
},
"loctrabalho": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Local de trabalho da entidade"
},
"Documentos": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"$ref": "ent-post.defs.json#/definitions/tipo_item_documento"
},
"description": "Documentos de uma Entidade"
},
"Contatos": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"$ref": "ent-post.defs.json#/definitions/tipo_item_contato"
},
"description": "Contatos da Entidade"
},
"Enderecos": {
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"$ref": "ent-post.defs.json#/definitions/tipo_item_endereco"
},
"description": "Endereços da Entidade"
},
"Perfis": {
"type": "array",
"minItems": 1,
"maxItems": 3,
"items": {
"$ref": "ent-post.defs.json#/definitions/tipo_perfil"
},
"description": "Perfis da Entidade"
}
},
"required": [
"pessoa",
"nome",
"fantasia"
],
"if": {
"properties": {
"pessoa": {
"const": "FISICA"
}
}
},
"then": {
"properties": {
"sexo": {
"type": "string"
},
"dtnasc": {
"type": "string",
"format": "date"
},
"estado_civil": {
"type": "string"
},
"loctrabalho": {
"type": "string"
}
}
},
"else": {
"not": {
"properties": {
"sexo": {},
"dtnasc": {},
"estado_civil": {},
"loctrabalho": {}
}
}
},
"definitions": {
"tipo_pessoa": {
"enum": [
"FISICA",
"JURIDICA"
],
"description": "Tipo da Pessoa"
},
"tipo_perfil": {
"enum": [
"CLIENTE",
"FORNECEDOR",
"TRANSPORTADOR",
"MOTORISTA",
"VENDEDOR"
],
"description": "Tipo do Perfil da Entidade"
},
"tipos_documento": {
"type": "integer",
"enum": [
1,
2,
3,
4,
11,
12
],
"description": "Tipo de documento.\n1-CNPJ\n2-CPF\n3-IE\n4-RG\n11-SUFRAMA\n12-IM"
},
"tipos_contato": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"description": "Tipo do contato.\n1-Telefone Fixo\n2-Telefone Móvel\n3-E-mail\n4-Telefone Comercial"
},
"tipos_endereco": {
"type": "integer",
"enum": [
1,
3,
5
],
"description": "Tipo de endereços.\n1-Endereço Principal\n3-Endereço de Cobrança\n5-Endereço de Entrega"
},
"tipo_sexo": {
"enum": [
"MASCULINO",
"FEMININO"
],
"description": "Tipo sexo da Entidade"
},
"tipo_estado_civil": {
"enum": [
"SOLTEIRO",
"CASADO",
"DIVORCIADO",
"DESQUITADO",
"VIUVO"
],
"description": "Tipo estado civil da Entidade"
},
"tipo_item_documento": {
"type": "object",
"additionalProperties": false,
"properties": {
"documento": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Número do documento com ou sem formatação"
},
"tipo_documento_id": {
"$ref": "ent-post.defs.json#/definitions/tipos_documento"
}
},
"required": [
"documento",
"tipo_documento_id"
],
"description": "Documento de uma Entidade"
},
"tipo_item_contato": {
"type": "object",
"additionalProperties": false,
"properties": {
"conteudo": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Dados do contato"
},
"tipo_contato_id": {
"$ref": "ent-post.defs.json#/definitions/tipos_contato"
}
},
"required": [
"conteudo",
"tipo_contato_id"
],
"description": "Contato de uma Entidade"
},
"tipo_item_endereco": {
"type": "object",
"additionalProperties": false,
"properties": {
"cep": {
"type": "string",
"pattern": "^[0-9]{5}-?[0-9]{3}$",
"description": "CEP do endereço com a máscara ou sem mascara. Exemplo: 12345-123 ou 12345123."
},
"logradouro": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Logradouro"
},
"numero": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "Número do endereço, poderá conter texto como KM ou S/N"
},
"bairro": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Bairro do endereço"
},
"codigo_ibge": {
"type": "integer",
"description": "Código IBGE da Cidade"
},
"cidade": {
"type": "string",
"description": "Nome da Cidade"
},
"complemento": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Complemento do endereço"
},
"tipo_endereco_id": {
"$ref": "ent-post.defs.json#/definitions/tipos_endereco"
}
},
"anyOf": [
{
"required": [
"codigo_ibge"
]
},
{
"required": [
"cidade"
]
}
],
"required": [
"cep",
"logradouro",
"numero",
"bairro",
"tipo_endereco_id"
],
"description": "Endereço de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 98231,
"codigo": null,
"pessoa": "FISICA",
"nome": "Nome de Teste",
"fantasia": "Fanta Asia",
"dtcad": "2024-10-23",
"ativo": "PENDENTE",
"AtividadeEntidade": {
"id": 1,
"codigo": "0111-3/01",
"descricao": "Cultivo de arroz",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
"Documentos": [
{
"id": 201816,
"documento": "651.285.630-90",
"TipoDocumento": {
"id": 2,
"descricao": "CPF"
}
}
],
"Contatos": [
{
"id": 333979,
"conteudo": "test@test.com",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
}
}
],
"Enderecos": [
{
"id": 102469,
"cep": "17015-311",
"logradouro": "Rua Rio Branco",
"numero": "15-15",
"bairro": "Centro",
"complemento": "Sala 72",
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
}
],
"Perfis": [
{
"id": 100699,
"tipo": "CLIENTE"
},
{
"id": 100700,
"tipo": "FORNECEDOR"
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação EntidadePOST/Entidade
Processo de Criação de Entidade.
Atenção!
O CNPJ e o CPF são opcionais, porém, o endpoint de Busca por Documentos será ineficaz se um dos documentos não for informado.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| id | Inteiro | Identificacao da entidade. Se informado o registro será updatado, se não, incluido |
|
| codigo | Inteiro | Código da entidade. | |
| pessoa | ✔️ | TipoPessoa | Tipo de Pessoa. Os valores possíveis para esse campo são: |
| nome | ✔️ | String(100) | Razão social / Nome da entidade. |
| fantasia | String(100) | Nome fantasia da entidade. | |
| dtcad | Date | Data do cadastro no formato "AAAA-MM-DD". |
|
| atividade_entidade_id | Inteiro | Id da Atividade da Entidade com base no Cadastro de Atividades do Sistema. | |
| sexo | TipoSexo | Sexo da entidade. Só permitido, se pessoa for FISICA. |
|
| dtnasc | Date | Data de nascimento da entidade. Só permitido, se pessoa for FISICA. |
|
| estado_civil | TipoEstadoCivil | Estado civil da entidade. Só permitido, se pessoa for FISICA. |
|
| loctrabalho | String(100) | Local de trabalho da entidade. Só permitido, se pessoa for FISICA. |
|
| Documentos | TipoItemDocumento[ ] | Conjunto de Documentos da Entidade | |
| Contatos | TipoItemContato[ ] | Conjunto de Contatos da Entidade | |
| Enderecos | TipoItemEndereco[ ] | Conjunto de Endereços da Entidade | |
| Perfis | TipoPerfil[ ] | Conjunto de Tipos de Perfils da Entidade |
Esse endpoint se obtiver succeso na inclusão retorná o ID da entidade registrada.
Tipos de dados usados:
Tipo de Pessoa
TipoPessoa
-
FISICA
-
JURIDICA
TipoPessoa
-
FISICA -
JURIDICA
Tipo Sexo
TipoSexo
-
MASCULINO
-
FEMININO
TipoSexo
-
MASCULINO -
FEMININO
Tipo Estado Civil
TipoEstadoCivil
-
SOLTEIRO
-
CASADO
-
DIVORCIADO
-
DESQUITADO
-
VIUVO
TipoEstadoCivil
-
SOLTEIRO -
CASADO -
DIVORCIADO -
DESQUITADO -
VIUVO
Tipo Item de Documento
TipoItemDocumento
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
id
Inteiro
Identificacao do endereço.
Se informado o registro será updatado, se não, incluido
documento
✔️
String(20)
Número do documento
tipo_documento_id
✔️
TipoDocumento
Tipo do documento
TipoItemDocumento
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| id | Inteiro | Identificacao do endereço. Se informado o registro será updatado, se não, incluido |
|
| documento | ✔️ | String(20) | Número do documento |
| tipo_documento_id | ✔️ | TipoDocumento | Tipo do documento |
Tipo Item de Contato
TipoItemContato
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
id
Inteiro
Identificacao do Contato.
Se informado o registro será updatado, se não, incluido
conteudo*
✔️
String(255)
Conteúdo do contato
tipo_contato_id*
✔️
TipoContato
Tipo do Contato
TipoItemContato
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| id | Inteiro | Identificacao do Contato. Se informado o registro será updatado, se não, incluido |
|
| conteudo* | ✔️ | String(255) | Conteúdo do contato |
| tipo_contato_id* | ✔️ | TipoContato | Tipo do Contato |
Tipo Item de Endereços
TipoItemEndereco
Campo
Obrigatório
Tipo do Campo
Descritivo do Campo
id
Inteiro
Identificacao do Endereço.
Se informado o registro será updatado, se não, incluido
cep
✔️
String(9)
Informar o CEP formatado. Exemplo: 17100-000
logradouro
✔️
String(100)
Logradouro do Endereço
numero
✔️
String(10)
Número do Endereço
bairro
✔️
String(60)
Bairro do Endereço
cidade
✔️
String(40)
Bairro do Endereço
uf
✔️
String(2)
Bairro do Endereço
complemento
String(60)
Bairro do Endereço
tipo_endereco_id
✔️
TipoEndereco
Tipo do Endereço
TipoItemEndereco
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| id | Inteiro | Identificacao do Endereço. Se informado o registro será updatado, se não, incluido |
|
| cep | ✔️ | String(9) | Informar o CEP formatado. Exemplo: 17100-000 |
| logradouro | ✔️ | String(100) | Logradouro do Endereço |
| numero | ✔️ | String(10) | Número do Endereço |
| bairro | ✔️ | String(60) | Bairro do Endereço |
| cidade | ✔️ | String(40) | Bairro do Endereço |
| uf | ✔️ | String(2) | Bairro do Endereço |
| complemento | String(60) | Bairro do Endereço | |
| tipo_endereco_id | ✔️ | TipoEndereco | Tipo do Endereço |
Tipo de Documento
TipoDocumento
-
1 - CNPJ
-
2 - CPF
-
3 - IE
-
4 - RG
-
11 - SUFRAMA
-
12 - IM
TipoDocumento
-
1- CNPJ -
2- CPF -
3- IE -
4- RG -
11- SUFRAMA -
12- IM
Tipo de Contato
TipoContato
-
1 - Telefone Fixo
-
2 - Telefone Móvel
-
3 - E-mail
-
4 - Telefone Comercial
TipoContato
-
1- Telefone Fixo -
2- Telefone Móvel -
3- E-mail -
4- Telefone Comercial
Tipo de Endereço
TipoEndereco
-
1 - Endereço Principal
-
3 - Endereço de Cobrança
-
5 - Endereço de Entrega
TipoEndereco
-
1- Endereço Principal -
3- Endereço de Cobrança -
5- Endereço de Entrega
Tipo de Perfil
TipoPerfil
-
CLIENTE - Clientes
-
FORNECEDOR - Fornecedores
-
TRANSPORTADOR - Transportadores
-
MOTORISTA - Motoristas
-
VENDEDOR - Vendedores
TipoPerfil
-
CLIENTE- Clientes -
FORNECEDOR- Fornecedores -
TRANSPORTADOR- Transportadores -
MOTORISTA- Motoristas -
VENDEDOR- Vendedores
GET https://open-api.eprom.com.br/api/Entidade?id=123&tipo=CLIENTE&documento=1332&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page" : 0,
"size" : 10,
"count" : 15,
"data" :
[
{
"id": 1,
"codigo": 0,
"pessoa": "JURIDICA",
"nome": "ONONONONONONON",
"fantasia": "ONONO",
"dtcad": "2022-05-24",
"ativo": "SIM",
"AtividadeEntidade": {
"id": 846,
"codigo": "4759-8/99",
"descricao": "Comércio varejista de outros artigos de uso pessoal e doméstico não especificados anteriormente",
"ClasseCnae": {
"id": 159,
"codigo": "20.71-1",
"descricao": "Comércio varejista de equipamentos de informática e comunicação; equipamentos e artigos de uso doméstico",
"GrupoCnae": {
"id": 159,
"codigo": "47.5",
"descricao": "Comércio varejista de equipamentos de informática e comunicação; equipamentos e artigos de uso doméstico",
"DivisaoCnae": {
"id": 43,
"codigo": "47",
"descricao": "COMÉRCIO VAREJISTA",
"SecaoCnae": {
"id": 7,
"codigo": "G",
"descricao": "COMÉRCIO; REPARAÇÃO DE VEÍCULOS AUTOMOTORES E MOTOCICLETAS"
}
}
}
}
},
"Documentos": [
{
"id": 1,
"documento": "12.123.456/0001-12",
"TipoDocumento": {
"id": 1,
"descricao": "CNPJ"
}
},
{
"id": 8435,
"documento": "123456789",
"TipoDocumento": {
"id": 3,
"descricao": "IE"
}
},
{
"id": 40310,
"documento": "123456",
"TipoDocumento": {
"id": 14,
"descricao": "Registro Junta Comercial"
}
}
],
"Contatos": [
{
"id": 1,
"conteudo": "(12) 1234-1234",
"TipoContato": {
"id": 1,
"descricao": "TELEFONE FIXO PRINCIPAL"
}
},
{
"id": 3,
"conteudo": "email@dominio.com.br",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
}
},
{
"id": 142956,
"conteudo": "(12) 567891564",
"TipoContato": {
"id": 4,
"descricao": "TELEFONE COMERCIAL"
}
}
],
"Enderecos": [
{
"id": 1,
"cep": "17000-000",
"logradouro": "RUA DAS RUAS",
"numero": "1137",
"bairro": "NON BAIRRO",
"complemento": "SALA 05",
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 1626,
"localidade": "CIDADE",
"codigo_ibge": 3512345,
"Uf": {
"id": 11,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
}
],
"Perfis": [
{
"id": 1,
"tipo": "FILIAL"
},
{
"id": 79108,
"tipo": "VENDEDOR"
}
]
},
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar EntidadesGET/Entidade{?id,tipo,documento,page,size}
Lista entidades.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a entidade pelo id.
- tipo
array[string](optional) Example: CLIENTETipo da Entidade. Pode ser um valor ou uma lista de valores separada por vírgula(,)
Choices:
CLIENTEFORNECEDORTRANSPORTADORMOTORISTAVENDEDOR- documento
string(optional) Example: 1332Número do documento a ser pesquisado ou parte do número.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Entidade/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"pessoa": "FISICA",
"nome": "Teste Nome",
"fantasia": "Fanta Asia",
"atividade_entidade_id": 2,
"sexo": "MASCULINO",
"dtnasc": "1990-01-30",
"estado_civil": "SOLTEIRO",
"loctrabalho": "local de trabalho"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-put.defs.json",
"type": "object",
"additionalProperties": false,
"properties": {
"codigo": {
"type": "integer",
"description": "Código definido pela empresa"
},
"pessoa": {
"$ref": "ent-put.defs.json#/definitions/tipo_pessoa"
},
"nome": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Nome da Entidade"
},
"fantasia": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Nome da Entidade"
},
"atividade_entidade_id": {
"type": "integer",
"description": "Id da Atividade comercial da Entidade. Consultar Atividades Comerciais para obter o Id."
},
"sexo": {
"$ref": "ent-put.defs.json#/definitions/tipo_sexo"
},
"dtnasc": {
"type": "string",
"format": "date",
"description": "Data de Nascimento"
},
"estado_civil": {
"$ref": "ent-put.defs.json#/definitions/tipo_estado_civil"
},
"loctrabalho": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Local de trabalho da entidade"
}
},
"required": [
"pessoa",
"nome",
"fantasia"
],
"if": {
"properties": {
"pessoa": {
"const": "FISICA"
}
}
},
"then": {
"properties": {
"sexo": {
"type": "string"
},
"dtnasc": {
"type": "string",
"format": "date"
},
"estado_civil": {
"type": "string"
},
"loctrabalho": {
"type": "string"
}
}
},
"else": {
"not": {
"properties": {
"sexo": {},
"dtnasc": {},
"estado_civil": {},
"loctrabalho": {}
}
}
},
"definitions": {
"tipo_pessoa": {
"enum": [
"FISICA",
"JURIDICA"
],
"description": "Tipo da Pessoa"
},
"tipo_sexo": {
"enum": [
"MASCULINO",
"FEMININO"
],
"description": "Tipo sexo da Entidade"
},
"tipo_estado_civil": {
"enum": [
"SOLTEIRO",
"CASADO",
"DIVORCIADO",
"DESQUITADO",
"VIUVO"
],
"description": "Tipo estado civil da Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 98231,
"codigo": null,
"pessoa": "FISICA",
"nome": "Teste Nome",
"fantasia": "Fanta Asia",
"dtcad": "2024-10-23",
"ativo": "PENDENTE",
"AtividadeEntidade": {
"id": 2,
"codigo": "0111-3/02",
"descricao": "Cultivo de milho",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
"Documentos": [
{
"id": 201816,
"documento": "651.285.630-90",
"TipoDocumento": {
"id": 2,
"descricao": "CPF"
}
}
],
"Contatos": [
{
"id": 333979,
"conteudo": "test@test.com",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
}
}
],
"Enderecos": [
{
"id": 102469,
"cep": "17015-311",
"logradouro": "Rua Rio Branco",
"numero": "15-15",
"bairro": "Centro",
"complemento": "Sala 72",
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
}
],
"Perfis": [
{
"id": 100699,
"tipo": "CLIENTE"
},
{
"id": 100700,
"tipo": "FORNECEDOR"
}
]
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração EntidadePUT/Entidade/{id}
Processo de Alteração de Entidade.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| codigo | Inteiro | Código da entidade. | |
| pessoa | ✔️ | TipoPessoa | Tipo de Pessoa. Os valores possíveis para esse campo são: |
| nome | ✔️ | String(100) | Razão social / Nome da entidade. |
| fantasia | String(100) | Nome fantasia da entidade. | |
| dtcad | Date | Data do cadastro no formato "AAAA-MM-DD". |
|
| atividade_entidade_id | Inteiro | Id da Atividade da Entidade com base no Cadastro de Atividades do Sistema. | |
| sexo | TipoSexo | Sexo da entidade. Só permitido, se pessoa for FISICA. |
|
| dtnasc | Date | Data de nascimento da entidade. Só permitido, se pessoa for FISICA. |
|
| estado_civil | TipoEstadoCivil | Estado civil da entidade. Só permitido, se pessoa for FISICA. |
|
| loctrabalho | String(100) | Local de trabalho da entidade. Só permitido, se pessoa for FISICA. |
Esse endpoint se obtiver succeso na alteração retorná o ID da entidade registrada.
URI Parameters
- id
number(required) Example: 123Id da entidade
DELETE https://open-api.eprom.com.br/api/Entidade/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Entidade excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão EntidadeDELETE/Entidade/{id}
Processo de Exclusão de Entidade.
URI Parameters
- id
number(required) Example: 123Id da entidade
Entidade Endereço ¶
Endpoints relativos ao cadastro de endereço das entidades (Clientes, Fornecedores, Transportadores, Vendedores).
POST https://open-api.eprom.com.br/api/Entidade/Endereco
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"entidade_id": 999,
"cep": "17015100",
"codigo_ibge": 3506003,
"bairro": "Centro",
"logradouro": "Rua das Ruas",
"numero": "15-15",
"complemento": "Sala 33",
"tipo_endereco_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-end-post.defs.json",
"allOf": [
{
"$ref": "ent-end-post.defs.json#/definitions/tipo_item_endereco"
}
],
"definitions": {
"tipos_endereco": {
"type": "integer",
"enum": [
1,
3,
5
],
"description": "Tipo de endereços.\n1-Endereço Principal\n3-Endereço de Cobrança\n5-Endereço de Entrega"
},
"tipo_item_endereco": {
"type": "object",
"additionalProperties": false,
"properties": {
"cep": {
"type": "string",
"pattern": "^[0-9]{5}-?[0-9]{3}$",
"description": "CEP do endereço com a máscara ou sem mascara. Exemplo: 12345-123 ou 12345123."
},
"logradouro": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Logradouro"
},
"numero": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "Número do endereço, poderá conter texto como KM ou S/N"
},
"bairro": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Bairro do endereço"
},
"codigo_ibge": {
"type": "integer",
"description": "Código IBGE da Cidade"
},
"complemento": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Complemento do endereço"
},
"tipo_endereco_id": {
"$ref": "ent-end-post.defs.json#/definitions/tipos_endereco"
}
},
"required": [
"cep",
"codigo_ibge",
"logradouro",
"numero",
"bairro",
"tipo_endereco_id"
],
"description": "Endereço de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 102464,
"logradouro": "Rua das Ruas",
"numero": "15-15",
"complemento": "Sala 33",
"bairro": "Centro",
"cep": "17015-100",
"Entidade": {
"id": 999,
"nome": "Onon Ononon Ononono"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação EndereçoPOST/Entidade/Endereco
Processo de Criação de Endereço da Entidade.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| entidade_id | ✔️ | Integer | Informar o id da Entidade para cadastro do endereço. |
| cep | ✔️ | String(9) | Informar o CEP formatado. Exemplo: 17100-000 |
| codigo_ibge | ✔️ | Integer | Código do IBGE da cidade. |
| bairro | ✔️ | String(60) | Bairro do Endereço |
| logradouro | ✔️ | String(100) | Logradouro do Endereço |
| numero | ✔️ | String(10) | Número do Endereço |
| complemento | String(60) | Bairro do Endereço | |
| tipo_endereco_id | ✔️ | TipoEndereco | Tipo do Endereço |
GET https://open-api.eprom.com.br/api/Entidade/Endereco?id=123&entidade_id=123&tipo=1&cep=17100000&uf=SP&cidade=BAURU&codigo_ibge=3506003&logradouro=Rua das ruas&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 98069,
"data": [
{
"id": 2,
"logradouro": "Moyses Leme Da Silva",
"numero": "2",
"complemento": "Casa",
"bairro": "Jardim Aeroporto",
"cep": "17017-335",
"Entidade": {
"id": 126,
"nome": "Esteban Mastroni Tentor"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 3,
"logradouro": "Rua Rio Branco",
"numero": "15-15",
"complemento": "Sala 72/73",
"bairro": "Centro",
"cep": "17015-311",
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 4,
"logradouro": "Rua Benjamim Constant",
"numero": "4",
"complemento": "",
"bairro": "Centro",
"cep": "86410-000",
"Entidade": {
"id": 12,
"nome": "Cley Embalagem Eng Conexoes"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 3491,
"localidade": "RIBEIRAO CLARO",
"codigo_ibge": 4121802,
"Uf": {
"id": 18,
"sigla": "PR",
"estado": "Paraná",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 5,
"logradouro": "Moyses Leme Da Silva",
"numero": "5",
"complemento": "Casa",
"bairro": "Jd. Aeroporto",
"cep": "17017-335",
"Entidade": {
"id": 13,
"nome": "Bernardi Melazi Rey Martines"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 6,
"logradouro": "Rio Branco",
"numero": "6",
"complemento": null,
"bairro": "Altos",
"cep": "17015-311",
"Entidade": {
"id": 11,
"nome": "Banco Itaú S/a"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 9,
"logradouro": "Rua Rio Branco",
"numero": "9",
"complemento": "Sala 23",
"bairro": "Centro",
"cep": "17015-311",
"Entidade": {
"id": 15,
"nome": "Martino Lewaschiw Bionovis Escritorios"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 10,
"logradouro": "Ddddddddddddddddddd",
"numero": "10",
"complemento": "",
"bairro": "Xxxx",
"cep": "99999-999",
"Entidade": {
"id": 16,
"nome": "Layara Scervianinas Uema Cesar"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 5646,
"localidade": "EXPORTACAO",
"codigo_ibge": 9999999,
"Uf": {
"id": 29,
"sigla": "EX",
"estado": "Exterior",
"Pais": {
"id": 7,
"nome": "EUA",
"codigo": 1055,
"sigla": "EUA"
}
}
}
},
{
"id": 11,
"logradouro": "Rua Tomé De Souza",
"numero": "11",
"complemento": null,
"bairro": "Vila Seabra",
"cep": "17060-020",
"Entidade": {
"id": 17,
"nome": "Ansila Queiroga Anjoletto Formigoni"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 13,
"logradouro": "R: Angelo Biggi",
"numero": "13",
"complemento": "",
"bairro": "Linhares",
"cep": "36060-620",
"Entidade": {
"id": 19,
"nome": "Barreto Desmonte Catdki"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 1764,
"localidade": "JUIZ DE FORA",
"codigo_ibge": 3136702,
"Uf": {
"id": 11,
"sigla": "MG",
"estado": "Minas Gerais",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
},
{
"id": 36,
"logradouro": "Rua Rio Branco",
"numero": "36",
"complemento": "Sala 72/73",
"bairro": "Centro",
"cep": "17017-335",
"Entidade": {
"id": 13,
"nome": "Bernardi Melazi Rey Martines"
},
"TipoEndereco": {
"id": 2,
"descricao": "COMERCIAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar EndereçosGET/Entidade/Endereco{?id,entidade_id,tipo,cep,uf,cidade,codigo_ibge,logradouro,page,size}
Lista endereços das entidades.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o endereço pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- entidade_id
number(optional) Example: 123Se informado id, buscará o endereço pelo id da entidade. Poderá ser informado uma lista de valores separada por vírgula(,).
- tipo
number(optional) Example: 1Tipo de endereços. Pode ser um valor ou uma lista de valores separada por vírgula(,) Os valores possíveis são os seguintes:
1- PRINCIPAL,2- COMERCIAL,3- COBRANÇA,4- CORRESPONDENCIA,5- ENTREGAChoices:
12345- cep
string(optional) Example: 17100000Informar o cep completo.
- uf
string(optional) Example: SPInformar a sigla do estado.
- cidade
string(optional) Example: BAURUInformar o nome ou parte do nome da cidade.
- codigo_ibge
number(optional) Example: 3506003Informar código do ibge da cidade.
- logradouro
string(optional) Example: Rua das ruasInformar o logradouro ou parte dele.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Entidade/Endereco/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"entidade_id": 999,
"cep": "17015100",
"codigo_ibge": 3506003,
"bairro": "Centro",
"logradouro": "Rua das Ruas",
"numero": "15-15",
"complemento": "Sala 33",
"tipo_endereco_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-end-post.defs.json",
"allOf": [
{
"$ref": "ent-end-post.defs.json#/definitions/tipo_item_endereco"
}
],
"definitions": {
"tipos_endereco": {
"type": "integer",
"enum": [
1,
3,
5
],
"description": "Tipo de endereços.\n1-Endereço Principal\n3-Endereço de Cobrança\n5-Endereço de Entrega"
},
"tipo_item_endereco": {
"type": "object",
"additionalProperties": false,
"properties": {
"cep": {
"type": "string",
"pattern": "^[0-9]{5}-?[0-9]{3}$",
"description": "CEP do endereço com a máscara ou sem mascara. Exemplo: 12345-123 ou 12345123."
},
"logradouro": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Logradouro"
},
"numero": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "Número do endereço, poderá conter texto como KM ou S/N"
},
"bairro": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Bairro do endereço"
},
"codigo_ibge": {
"type": "integer",
"description": "Código IBGE da Cidade"
},
"complemento": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Complemento do endereço"
},
"tipo_endereco_id": {
"$ref": "ent-end-post.defs.json#/definitions/tipos_endereco"
}
},
"required": [
"cep",
"codigo_ibge",
"logradouro",
"numero",
"bairro",
"tipo_endereco_id"
],
"description": "Endereço de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 102464,
"logradouro": "Rua das Ruas",
"numero": "15-15",
"complemento": "Sala 33",
"bairro": "Centro",
"cep": "17015-100",
"Entidade": {
"id": 999,
"nome": "Onon Ononon Ononono"
},
"TipoEndereco": {
"id": 1,
"descricao": "PRINCIPAL"
},
"Cidade": {
"id": 4845,
"localidade": "BAURU",
"codigo_ibge": 3506003,
"Uf": {
"id": 26,
"sigla": "SP",
"estado": "São Paulo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração EndereçoPUT/Entidade/Endereco/{id}
Processo de Alteração de Endereço.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| entidade_id | ✔️ | Integer | Informar o id da Entidade para cadastro do endereço. |
| cep | ✔️ | String(9) | Informar o CEP formatado. Exemplo: 17100-000 |
| codigo_ibge | ✔️ | Integer | Código do IBGE da cidade. |
| bairro | ✔️ | String(60) | Bairro do Endereço |
| logradouro | ✔️ | String(100) | Logradouro do Endereço |
| numero | ✔️ | String(10) | Número do Endereço |
| complemento | String(60) | Bairro do Endereço | |
| tipo_endereco_id | ✔️ | TipoEndereco | Tipo do Endereço |
URI Parameters
- id
number(required) Example: 123Id do endereço a ser alterado.
DELETE https://open-api.eprom.com.br/api/Entidade/Endereco/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Endereço da Entidade excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão de EndereçoDELETE/Entidade/Endereco/{id}
Processo de Exclusão de Endereço de uma Entidade.
URI Parameters
- id
number(required) Example: 123Id do endereço da Entidade.
Entidade Contato ¶
Endpoints relativos ao cadastro de Contato das entidades (Clientes, Fornecedores, Transportadores, Vendedores).
POST https://open-api.eprom.com.br/api/Entidade/Contato
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"entidade_id": 999,
"tipo_contato_id": 3,
"conteudo": "test@test.com"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-cont-post.defs.json",
"allOf": [
{
"$ref": "ent-cont-post.defs.json#/definitions/tipo_item_contato"
}
],
"definitions": {
"tipos_contato": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"description": "Tipo do contato.\n1-Telefone Fixo\n2-Telefone Móvel\n3-E-mail\n4-Telefone Comercial"
},
"tipo_item_contato": {
"type": "object",
"additionalProperties": false,
"properties": {
"entidade_id": {
"type": "integer"
},
"conteudo": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Dados do contato"
},
"tipo_contato_id": {
"$ref": "ent-cont-post.defs.json#/definitions/tipos_contato"
}
},
"required": [
"entidade_id",
"conteudo",
"tipo_contato_id"
],
"description": "Contato de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 333974,
"conteudo": "test@test.com",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
},
"Entidade": {
"id": 999,
"nome": "Will Gerlania Bernardo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação ContatoPOST/Entidade/Contato
Processo de Criação de Contato da Entidade.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| entidade_id | ✔️ | Inteiro | Informar o Id da entidade que se vai vincular o contato. |
| conteudo | ✔️ | String(255) | Conteúdo do contato |
| tipo_contato_id | ✔️ | TipoContato | Tipo do Contato |
GET https://open-api.eprom.com.br/api/Entidade/Contato?id=123&entidade_id=123&conteudo=jose&tipo=1&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 292215,
"data": [
{
"id": 17,
"conteudo": "desenvolvimento@eprom.com.br",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
},
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
}
},
{
"id": 101,
"conteudo": "(14) 2108-9999",
"TipoContato": {
"id": 1,
"descricao": "TELEFONE FIXO PRINCIPAL"
},
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
}
},
{
"id": 162,
"conteudo": "nfe@eprom.com.br",
"TipoContato": {
"id": 6,
"descricao": "Email NFe"
},
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
}
},
{
"id": 163,
"conteudo": "financeiro@eprom.com.br",
"TipoContato": {
"id": 7,
"descricao": "Email Financeiro"
},
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
}
},
{
"id": 813,
"conteudo": "www.eprom.com.br",
"TipoContato": {
"id": 8,
"descricao": "Home Page"
},
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
}
},
{
"id": 4032,
"conteudo": "(14) 98137-6855",
"TipoContato": {
"id": 23,
"descricao": "WhatsApp"
},
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
}
},
{
"id": 4183,
"conteudo": "brusilo.10@eprteste.com.br",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
},
"Entidade": {
"id": 10,
"nome": "Brusilo Pagani Biaty"
}
},
{
"id": 4184,
"conteudo": "(14) 92101-0101",
"TipoContato": {
"id": 2,
"descricao": "TELEFONE MOVEL PRINCIPAL"
},
"Entidade": {
"id": 10,
"nome": "Brusilo Pagani Biaty"
}
},
{
"id": 4185,
"conteudo": "(14) 2110-1010",
"TipoContato": {
"id": 1,
"descricao": "TELEFONE FIXO PRINCIPAL"
},
"Entidade": {
"id": 10,
"nome": "Brusilo Pagani Biaty"
}
},
{
"id": 4186,
"conteudo": "banco.11@eprteste.com.br",
"TipoContato": {
"id": 3,
"descricao": "EMAIL"
},
"Entidade": {
"id": 11,
"nome": "Banco Itaú S/a"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar ContatosGET/Entidade/Contato{?id,entidade_id,conteudo,tipo,page,size}
Lista Contatos das entidades.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o contato pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- entidade_id
number(optional) Example: 123Se informado id, buscará o contato pelo id da entidade. Poderá ser informado uma lista de valores separada por vírgula(,).
- conteudo
string(optional) Example: joseInformar o conteúdo do contato ou parte dele.
- tipo
number(optional) Example: 1Tipo de Contatos. Pode ser um valor ou uma lista de valores separada por vírgula(,). As opções são :
1- Telefone Fixo,2- Telefone Móvel,3- E-mail e4- Telefone ComercialChoices:
1234- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Entidade/Contato/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"conteudo": "test@test.com"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-cont-put.defs.json",
"allOf": [
{
"$ref": "ent-cont-put.defs.json#/definitions/tipo_item_contato"
}
],
"definitions": {
"tipo_item_contato": {
"type": "object",
"additionalProperties": false,
"properties": {
"conteudo": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Dados do contato"
}
},
"required": [
"conteudo"
],
"description": "Contato de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 99999,
"entidade_id": 31755,
"conteudo": "test@test.com"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração ContatoPUT/Entidade/Contato/{id}
Processo de Alteração de um contato.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| conteudo | ✔️ | String(255) | Conteúdo do contato |
URI Parameters
- id
number(required) Example: 123Id do contato a ser alterado.
DELETE https://open-api.eprom.com.br/api/Entidade/Contato/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Contato da Entidade excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão de ContatosDELETE/Entidade/Contato/{id}
Processo de Exclusão de Contatos de uma Entidade.
URI Parameters
- id
number(required) Example: 123Id do Contato da Entidade.
Entidade Documento ¶
Endpoints relativos ao cadastro de Documento das entidades (Clientes, Fornecedores, Transportadores, Vendedores).
POST https://open-api.eprom.com.br/api/Entidade/Documento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"entidade_id": 999,
"tipo_documento_id": 2,
"documento": "999.999.999-00"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-doc-post.defs.json",
"allOf": [
{
"$ref": "ent-doc-post.defs.json#/definitions/tipo_item_documento"
}
],
"definitions": {
"tipos_documento": {
"type": "integer",
"enum": [
1,
2,
3,
4,
11,
12
],
"description": "Tipo de documento.\n1-CNPJ\n2-CPF\n3-IE\n4-RG\n11-SUFRAMA\n12-IM"
},
"tipo_item_documento": {
"type": "object",
"additionalProperties": false,
"properties": {
"entidade_id": {
"type": "integer"
},
"documento": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Número do documento com ou sem formatação"
},
"tipo_documento_id": {
"$ref": "ent-doc-post.defs.json#/definitions/tipos_documento"
}
},
"required": [
"entidade_id",
"documento",
"tipo_documento_id"
],
"description": "Documento de uma Entidade",
"allOf": [
{
"if": {
"properties": {
"tipo_documento_id": {
"const": 1
}
}
},
"then": {
"properties": {
"documento": {
"pattern": "[A-Z0-9]{12}[0-9]{2}|[A-Z0-9]{2}\\.[A-Z0-9]{3}\\.[A-Z0-9]{3}/[A-Z0-9]{4}-[0-9]{2}"
}
}
}
},
{
"if": {
"properties": {
"tipo_documento_id": {
"const": 2
}
}
},
"then": {
"properties": {
"documento": {
"pattern": "[0-9]{11}|[0-9]{3}\\.[0-9]{3}\\.[0-9]{3}-[0-9]{2}"
}
}
}
}
]
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 201806,
"documento": "999.999.999-00",
"TipoDocumento": {
"id": 2,
"descricao": "CPF"
},
"Entidade": {
"id": 999,
"nome": "Will Gerlania Bernardo"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação DocumentoPOST/Entidade/Documento
Processo de Criação de Documento da Entidade.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| entidade_id | ✔️ | Inteiro | Informar o Id da entidade que se vai vincular o Documento. |
| tipo_documento_id | ✔️ | TipoDocumento | Tipo do Documento |
| documento | ✔️ | String(20) | Conteúdo do Documento |
GET https://open-api.eprom.com.br/api/Entidade/Documento?id=123&entidade_id=123&documento=jose&tipo=1&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 100117,
"data": [
{
"id": 10,
"documento": "123456",
"TipoDocumento": {
"id": 8,
"descricao": "Registro Nacional de Estrangeiro (RNE)"
},
"Entidade": {
"id": 16,
"nome": "Layara Scervianinas Uema Cesar"
}
},
{
"id": 11,
"documento": "1SP324313/O-2",
"TipoDocumento": {
"id": 9,
"descricao": "Registro Orgão de Classe (OC)"
},
"Entidade": {
"id": 126,
"nome": "Esteban Mastroni Tentor"
}
},
{
"id": 15,
"documento": "151717171717",
"TipoDocumento": {
"id": 4,
"descricao": "RG"
},
"Entidade": {
"id": 17,
"nome": "Ansila Queiroga Anjoletto Formigoni"
}
},
{
"id": 17,
"documento": "171818181818",
"TipoDocumento": {
"id": 3,
"descricao": "IE"
},
"Entidade": {
"id": 18,
"nome": "Sim Cordeiro Itarare"
}
},
{
"id": 19,
"documento": "191919191919",
"TipoDocumento": {
"id": 3,
"descricao": "IE"
},
"Entidade": {
"id": 19,
"nome": "Barreto Desmonte Catdki"
}
},
{
"id": 48,
"documento": "482121212121",
"TipoDocumento": {
"id": 3,
"descricao": "IE"
},
"Entidade": {
"id": 21,
"nome": "Oficial Edificios Granosul"
}
},
{
"id": 49,
"documento": "123456",
"TipoDocumento": {
"id": 10,
"descricao": "Suframa"
},
"Entidade": {
"id": 21,
"nome": "Oficial Edificios Granosul"
}
},
{
"id": 50,
"documento": "122221111",
"TipoDocumento": {
"id": 12,
"descricao": "Inscrição no orgão X"
},
"Entidade": {
"id": 21,
"nome": "Oficial Edificios Granosul"
}
},
{
"id": 51,
"documento": "511313131313",
"TipoDocumento": {
"id": 4,
"descricao": "RG"
},
"Entidade": {
"id": 13,
"nome": "Bernardi Melazi Rey Martines"
}
},
{
"id": 52,
"documento": "111111x",
"TipoDocumento": {
"id": 13,
"descricao": "Conta bancária 1"
},
"Entidade": {
"id": 13,
"nome": "Bernardi Melazi Rey Martines"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar DocumentosGET/Entidade/Documento{?id,entidade_id,documento,tipo,page,size}
Lista Documentos das entidades.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o Documento pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- entidade_id
number(optional) Example: 123Se informado id, buscará o Documento pelo id da entidade. Poderá ser informado uma lista de valores separada por vírgula(,).
- documento
string(optional) Example: joseInformar o conteúdo do Documento ou parte dele.
- tipo
number(optional) Example: 1Tipo de Documentos. Pode ser um valor ou uma lista de valores separada por vírgula(,). As opções são :
1- CNPJ,2- CPF,3- IE ,4- RG,11- SUFRAMA,12- IMChoices:
12341112- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Entidade/Documento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"documento": "999.999.999-00"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-doc-put.defs.json",
"allOf": [
{
"$ref": "ent-doc-put.defs.json#/definitions/tipo_item_documento"
}
],
"definitions": {
"tipo_item_documento": {
"type": "object",
"additionalProperties": false,
"properties": {
"documento": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Número do documento com ou sem formatação"
}
},
"required": [
"documento"
],
"description": "Documento de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 15,
"entidade_id": 17,
"documento": "999.999.999-00"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração DocumentoPUT/Entidade/Documento/{id}
Processo de Alteração de um Documento.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| documento | ✔️ | String(20) | Conteúdo do Documento |
URI Parameters
- id
number(required) Example: 123Id do Documento a ser alterado.
DELETE https://open-api.eprom.com.br/api/Entidade/Documento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Documento da Entidade excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão de DocumentosDELETE/Entidade/Documento/{id}
Processo de Exclusão de Documentos de uma Entidade.
URI Parameters
- id
number(required) Example: 123Id do Documento da Entidade.
Entidade Tipo ¶
Endpoints relativos ao cadastro de Tipos das entidades (Clientes, Fornecedores, Transportadores, Vendedores).
POST https://open-api.eprom.com.br/api/Entidade/Tipo
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"entidade_id": 999,
"tipo": "CLIENTE"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-tipo-post.defs.json",
"allOf": [
{
"$ref": "ent-tipo-post.defs.json#/definitions/tipo_item_perfil"
}
],
"definitions": {
"tipo_perfil": {
"enum": [
"CLIENTE",
"FORNECEDOR",
"TRANSPORTADOR",
"MOTORISTA",
"VENDEDOR"
],
"description": "Tipo do Perfil da Entidade"
},
"tipo_item_perfil": {
"type": "object",
"additionalProperties": false,
"properties": {
"entidade_id": {
"type": "integer"
},
"tipo": {
"$ref": "ent-tipo-post.defs.json#/definitions/tipo_perfil"
}
},
"required": [
"entidade_id",
"tipo"
],
"description": "Documento de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 157763,
"tipo": "CLIENTE",
"Entidade": {
"id": 999,
"nome": "DAYANNE RODRIGUES DOS SANTOS"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação TipoPOST/Entidade/Tipo
Processo de Criação de Tipo da Entidade.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| entidade_id | ✔️ | Inteiro | Informar o Id da entidade que se vai vincular o Tipo. |
| tipo | ✔️ | TipoPerfil | Tipo do Tipo |
GET https://open-api.eprom.com.br/api/Entidade/Tipo?id=123&entidade_id=123&tipo=CLIENTE&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 104531,
"data": [
{
"id": 5431,
"tipo": "CLIENTE",
"Entidade": {
"id": 83,
"nome": "A. R. SILVA e SILVA COMERCIO LTDA"
}
},
{
"id": 16910,
"tipo": "CLIENTE",
"Entidade": {
"id": 2,
"nome": "Ailton Rodrigo da silva"
}
},
{
"id": 16911,
"tipo": "CLIENTE",
"Entidade": {
"id": 10,
"nome": "AILTON RODRIGO DA SILVA"
}
},
{
"id": 16916,
"tipo": "CLIENTE",
"Entidade": {
"id": 11,
"nome": "CLAUDIO TONIN"
}
},
{
"id": 16918,
"tipo": "CLIENTE",
"Entidade": {
"id": 12,
"nome": "FABIANA LEME DA SILVA"
}
},
{
"id": 16928,
"tipo": "CLIENTE",
"Entidade": {
"id": 13,
"nome": "PEDRO JOSE DA SILVA"
}
},
{
"id": 16934,
"tipo": "CLIENTE",
"Entidade": {
"id": 15,
"nome": "MOISES BARBOSA"
}
},
{
"id": 16949,
"tipo": "CLIENTE",
"Entidade": {
"id": 16,
"nome": "MATHEUS CRESTA DOS SANTOS"
}
},
{
"id": 78771,
"tipo": "CLIENTE",
"Entidade": {
"id": 17,
"nome": "GIOVANE AMARANTE DE SOUSA SILVA"
}
},
{
"id": 86308,
"tipo": "CLIENTE",
"Entidade": {
"id": 20,
"nome": "STONE PAGAMENTOS"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar TiposGET/Entidade/Tipo{?id,entidade_id,tipo,page,size}
Lista Tipos das entidades.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o Tipo pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- entidade_id
number(optional) Example: 123Se informado id, buscará o Tipo pelo id da entidade. Poderá ser informado uma lista de valores separada por vírgula(,).
- tipo
string(optional) Example: CLIENTETipo de Tipos. Pode ser um valor ou uma lista de valores separada por vírgula(,). As opções são :
CLIENTE- Clientes,FORNECEDOR- Fornecedores,TRANSPORTADOR- Transportadores,MOTORISTA- Motoristas,VENDEDOR- VendedoresChoices:
CLIENTEFORNECEDORTRANSPORTADORMOTORISTAVENDEDOR- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Entidade/Tipo/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"tipo": "CLIENTE"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-tipo-put.defs.json",
"allOf": [
{
"$ref": "ent-tipo-put.defs.json#/definitions/tipo_item_perfil"
}
],
"definitions": {
"tipo_perfil": {
"enum": [
"CLIENTE",
"FORNECEDOR",
"TRANSPORTADOR",
"MOTORISTA",
"VENDEDOR"
],
"description": "Tipo do Perfil da Entidade"
},
"tipo_item_perfil": {
"type": "object",
"additionalProperties": false,
"properties": {
"tipo": {
"$ref": "ent-tipo-put.defs.json#/definitions/tipo_perfil"
}
},
"required": [
"tipo"
],
"description": "Documento de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 15,
"entidade_id": 17,
"documento": "999.999.999-00"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração TipoPUT/Entidade/Tipo/{id}
Processo de Alteração de um Tipo.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| tipo | ✔️ | TipoPerfil | Tipo do Tipo |
URI Parameters
- id
number(required) Example: 123Id do Tipo a ser alterado.
DELETE https://open-api.eprom.com.br/api/Entidade/Tipo/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Tipo excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão de TiposDELETE/Entidade/Tipo/{id}
Processo de Exclusão de Tipos de uma Entidade.
URI Parameters
- id
number(required) Example: 123Id do Tipo da Entidade.
Entidade Vinculo ¶
Endpoints relativos ao cadastro de Vinculo das entidades (Clientes, Fornecedores, Transportadores, Vendedores).
POST https://open-api.eprom.com.br/api/Entidade/Vinculo
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"tipo_vinculo": "COMPRADOR",
"entidade_id": 2,
"vinculo_id": 5
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-vinc-post.defs.json",
"allOf": [
{
"$ref": "ent-vinc-post.defs.json#/definitions/tipo_item_vinculo"
}
],
"definitions": {
"tipos_vinculo": {
"type": "string",
"enum": [
"VENDEDOR",
"TRANSPORTADOR",
"PROPRIETÁRIO",
"REPRESENTANTE",
"COMPRADOR",
"RESPONSAVEL FISCAL"
],
"description": "Tipos de Vínculos."
},
"tipo_item_vinculo": {
"type": "object",
"additionalProperties": false,
"properties": {
"entidade_id": {
"type": "integer"
},
"vinculo_id": {
"type": "integer"
},
"tipo_vinculo": {
"$ref": "ent-vinc-post.defs.json#/definitions/tipos_vinculo"
}
},
"required": [
"entidade_id",
"tipo_vinculo",
"vinculo_id"
],
"description": "Vínculos de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 72,
"tipo": "COMPRADOR",
"Entidade": {
"id": 2,
"nome": "ONONONONONON"
},
"Vinculo": {
"id": 5,
"nome": "XPTO XPTO"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação VinculoPOST/Entidade/Vinculo
Processo de Criação de Vinculo da Entidade.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| tipo_vinculo | ✔️ | TipoVinculo | Tipo do Vinculo |
| entidade_id | ✔️ | Inteiro | Informar o Id da entidade que se vai criar o Vinculo com outra entidade_id. |
| vinculo_id | ✔️ | Inteiro | Informar o Id da entidade que será vinculada à entidade_id. |
Tipos de dados usados:
Tipo de Vínculo
TipoVinculo
-
VENDEDOR
-
TRANSPORTADOR
-
PROPRIETÁRIO
-
REPRESENTANTE
-
COMPRADOR
-
RESPONSAVEL FISCAL
TipoVinculo
-
VENDEDOR -
TRANSPORTADOR -
PROPRIETÁRIO -
REPRESENTANTE -
COMPRADOR -
RESPONSAVEL FISCAL
GET https://open-api.eprom.com.br/api/Entidade/Vinculo?id=123&entidade_id=123&tipo_vinculo=VENDEDOR&vinculo_id=123&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 1,
"data": [
{
"id": 86,
"tipo": "TRANSPORTADOR",
"Entidade": {
"id": 25,
"nome": "CLIENTE TESTE"
},
"Vinculo": {
"id": 26,
"nome": "MISAEL CANDIDO ALVES"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar VínculosGET/Entidade/Vinculo{?id,entidade_id,tipo_vinculo,vinculo_id,page,size}
Lista Vínculos das entidades.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o Vínculo pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- entidade_id
number(optional) Example: 123Se informado id, buscará os Vínculos pelo id da entidade. Poderá ser informado uma lista de valores separada por vírgula(,).
- tipo_vinculo
string(optional) Example: VENDEDORTipo de Vínculos. Pode ser um valor ou uma lista de valores separada por vírgula(,). As opções são :
VENDEDOR,TRANSPORTADOR,PROPRIETÁRIO,REPRESENTANTE,COMPRADOR,RESPONSAVEL FISCALChoices:
VENDEDORTRANSPORTADORPROPRIETÁRIOREPRESENTANTECOMPRADORRESPONSAVEL FISCAL- vinculo_id
number(optional) Example: 123Se informado id, buscará os Vínculos pelo id do vínculo. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Entidade/Vinculo/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"tipo_vinculo": "VENDEDOR"
"vinculo_id": 26
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/ent-vinc-put.defs.json",
"allOf": [
{ "$ref": "ent-vinc-put.defs.json#/definitions/tipo_item_vinculo"}
],
"definitions": {
"tipos_vinculo": {
"type": "string",
"enum": [
"VENDEDOR",
"TRANSPORTADOR",
"PROPRIETÁRIO",
"REPRESENTANTE",
"COMPRADOR",
"RESPONSAVEL FISCAL" ],
"description": "Tipos de Vínculos."
},
"tipo_item_vinculo": {
"type": "object",
"additionalProperties": false,
"properties": {
"entidade_id": {
"type": "integer"
},
"vinculo_id": {
"type": "integer"
},
"tipo_vinculo": {
"$ref": "ent-vinc-put.defs.json#/definitions/tipos_vinculo"
}
},
"required": [
"tipo_vinculo",
"vinculo_id"
],
"description": "Vínculos de uma Entidade"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 86,
"entidade_id": 25,
"tipo_vinculo_id": 4,
"entidade_id_vinc": 26
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração VínculoPUT/Entidade/Vinculo/{id}
Processo de Alteração de um Vínculo.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| tipo_vinculo | ✔️ | TipoVinculo | Tipo do Vínculo |
| vinculo_id | ✔️ | Inteiro | Informar o Id da entidade que será vinculada à entidade_id. |
URI Parameters
- id
number(required) Example: 123Id do Vínculo a ser alterado.
DELETE https://open-api.eprom.com.br/api/Entidade/Vinculo/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Vinculo excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão de VínculosDELETE/Entidade/Vinculo/{id}
Processo de Exclusão de Vínculos de uma Entidade.
URI Parameters
- id
number(required) Example: 123Id do Vinculo da Entidade.
Equipamentos ¶
Nesse grupo iremos trabalhar todos os itens de cadastro de equipamentos.
Equipamentos ¶
Endpoints relativos ao cadastro de equipamentos.
POST https://open-api.eprom.com.br/api/Equipamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"marca_id": 1,
"modelo_id": 1,
"descricao": "<descricao>",
"referencia": "<referencia>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marca_id": {
"type": "number",
"description": "Id da marca do equipamento."
},
"modelo_id": {
"type": "number",
"description": "Id do modelo do equipamento."
},
"descricao": {
"type": "string",
"description": "Descrição do equipamento."
},
"referencia": {
"type": "string",
"description": "Referência do equipamento."
}
},
"required": [
"descricao",
"referencia"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 1,
"descricao": "Teste equipamento",
"referencia": "teste de referencia",
"ativo": "SIM",
"Marca": null,
"Modelo": null
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação EquipamentoPOST/Equipamento
Processo de Criação de Equipamento.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| marca_id | Inteiro | Id da Marca do Equipamento. | |
| modelo_id | Inteiro | Id do Modelo do Equipamento. | |
| descricao | ✔️ | String(60) | Descrição do Equipamento. |
| referencia | ✔️ | String(50) | Referência do Equipamento. |
Esse endpoint se obtiver succeso na inclusão retorná o ID do equipamento registrado.
GET https://open-api.eprom.com.br/api/Equipamento?id=123&marca_id=1&modelo_id=1&descricao=xxxx&referencia=xxxx&ativo=SIM&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 1,
"data": [
{
"id": 1,
"descricao": "Teste equipamento",
"referencia": "teste de referencia",
"ativo": "SIM",
"Marca": null,
"Modelo": null
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar EquipamentosGET/Equipamento{?id,marca_id,modelo_id,descricao,referencia,ativo,page,size}
Lista Equipamentos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o equipamento pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- marca_id
number(optional) Example: 1Se informado id da marca, buscará o equipamento pelo id da marca. Poderá ser informado uma lista de valores separada por vírgula(,).
- modelo_id
number(optional) Example: 1Se informado id do modelo, buscará o equipamento pelo id ddo modelo. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: xxxxDescrição do equipamento ou parte da descrição.
- referencia
string(optional) Example: xxxxReferência do equipamento ou parte da referência.
- ativo
enum(optional) Example: SIMEquipamento Ativo?
Choices:
SIMNAO- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Equipamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"marca_id": 1,
"modelo_id": 1,
"descricao": "<descricao>",
"referencia": "<referencia>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marca_id": {
"type": "number",
"description": "Id da marca do equipamento."
},
"modelo_id": {
"type": "number",
"description": "Id do modelo do equipamento."
},
"descricao": {
"type": "string",
"description": "Descrição do equipamento."
},
"referencia": {
"type": "string",
"description": "Referência do equipamento."
}
},
"required": [
"descricao",
"referencia"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 1,
"descricao": "Teste equipamento x",
"referencia": "Referencia alterada"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração EquipamentoPUT/Equipamento/{id}
Processo de Alteração de Equipamento.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| marca_id | Inteiro | Id da Marca do Equipamento. | |
| modelo_id | Inteiro | Id do Modelo do Equipamento. | |
| descricao | ✔️ | String(60) | Descrição do Equipamento. |
| referencia | ✔️ | String(50) | Referência do Equipamento. |
URI Parameters
- id
number(required) Example: 123Id do equipamento
DELETE https://open-api.eprom.com.br/api/Equipamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Equipamento excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão EquipamentoDELETE/Equipamento/{id}
Processo de Exclusão de Equipamento.
URI Parameters
- id
number(required) Example: 123Id do equipamento
Produtos ¶
Nesse grupo iremos trabalhar as tabelas relativas aos produtos.
Classificação Fiscal ¶
Endpoints relativos à Classificação Fiscal de produtos.
GET https://open-api.eprom.com.br/api/Produto/ClassificacaoFiscal?id=123&ncm=12345678&descricao=Produto&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 10652,
"data": [
{
"id": 1,
"ncm": 99999999,
"descricao": "PRESTAÇÂO DE SERVIÇO"
},
{
"id": 2,
"ncm": 1011010,
"descricao": "Cavalos reprodutores de raça pura"
},
{
"id": 3,
"ncm": 1011090,
"descricao": "Animais da espécie asinina/muar, reprodutores, raça pura"
},
{
"id": 4,
"ncm": 1012100,
"descricao": "Cavalos reprodutores de raça pura"
},
{
"id": 5,
"ncm": 1012900,
"descricao": "Cavalos, exceto reprodutores de raça pura"
},
{
"id": 6,
"ncm": 1013000,
"descricao": "Animais espécie asinina/muar, reprodutores de raça pura"
},
{
"id": 7,
"ncm": 1019000,
"descricao": "Animais espécie asinina/muar, exceto reprodutores de raça pura"
},
{
"id": 8,
"ncm": 1019010,
"descricao": "Cavalos vivos, exceto reprodutores raça pura"
},
{
"id": 9,
"ncm": 1019090,
"descricao": "Animais espécie asinina/muar, exceto reprodutores de raça pura pura"
},
{
"id": 10,
"ncm": 1021010,
"descricao": "Bovinos reprodutores de raça pura, prenhe ou cria ao pé"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Classificações Fiscais - ListarGET/Produto/ClassificacaoFiscal{?id,ncm,descricao,page,size}
Lista de Classificações Fiscais
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Classificação Fiscal do Produtos pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- ncm
number(optional) Example: 12345678NCM da Classificação Fiscal. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: ProdutoDescrição da Classificação Fiscal de Produtos ou parte dela.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
Grupo de Produtos ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto/Grupo
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"grupo": "TST",
"descricao": "Grupo Teste"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"grupo": {
"type": "string",
"maxLength": 10,
"description": "Sigla do Grupo de Produtos."
},
"descricao": {
"type": "string",
"maxLength": 60,
"description": "Descrição do Grupo de Produtos."
}
},
"required": [
"sigla",
"descricao"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 89,
"grupo": "TST",
"descricao": "Grupo Teste",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Grupo ProdutoPOST/Produto/Grupo
Processo de Criação de uma Grupo Produto de Produtos. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| grupo | ✔️ | String(10) | Informar a Sigla da Grupo de Produtos. |
| descricao | ✔️ | String(60) | Informar a descrição da Grupo de Produtos. |
GET https://open-api.eprom.com.br/api/Produto/Grupo?id=123&grupo=TST&descricao=Grupo&ativo=SIM&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 66,
"data": [
{
"id": 1,
"grupo": "001",
"descricao": "DIVERSOS",
"ativo": "SIM"
},
{
"id": 2,
"grupo": "002",
"descricao": "PAPELARIA",
"ativo": "SIM"
},
{
"id": 4,
"grupo": "20",
"descricao": "CONEXÕES ÁGUA",
"ativo": "SIM"
},
{
"id": 5,
"grupo": "21",
"descricao": "CONEXÕES P/ ESGOTO",
"ativo": "SIM"
},
{
"id": 6,
"grupo": "50",
"descricao": "TUBOS FLANGEADOS",
"ativo": "SIM"
},
{
"id": 7,
"grupo": "55",
"descricao": "TUBOS CILÍNDRICOS",
"ativo": "SIM"
},
{
"id": 8,
"grupo": "51",
"descricao": "TUBOS FLANGEADOS P/ ESGOTO",
"ativo": "SIM"
},
{
"id": 9,
"grupo": "60",
"descricao": "ACESSÓRIOS",
"ativo": "SIM"
},
{
"id": 10,
"grupo": "40",
"descricao": "TAMPÕES",
"ativo": "SIM"
},
{
"id": 11,
"grupo": "61",
"descricao": "ACESSÓRIOS P/ ESGOTO",
"ativo": "SIM"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Unidades MedidasGET/Produto/Grupo{?id,grupo,descricao,ativo,page,size}
Lista Unidades de Medidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Grupo de Produtos pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- grupo
string(optional) Example: TSTSigla do Grupo de produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: GrupoDescrição da Grupo de Produtos ou parte dela .
- ativo
string(optional) Example: SIMIndicar se ativo.
Choices:
SIMNAO- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/Grupo/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"grupo": "TST",
"descricao": "Grupo de Teste",
"ativo": "SIM"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"grupo": {
"type": "string",
"maxLength": 10,
"description": "Sigla da Grupo de Produtos."
},
"descricao": {
"type": "string",
"maxLength": 60,
"description": "Descrição da Grupo de Produtos."
},
"ativo": {
"enum": [
"SIM",
"NAO"
],
"description": "Ativo ou Inativa."
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 89,
"grupo": "TST",
"descricao": "Grupo Teste",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Grupo ProdutoPUT/Produto/Grupo/{id}
Processo de Alteração da Grupo de Produtos.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| grupo | String(10) | Informar a Sigla da Grupo de Produtos. | |
| descricao | String(60) | Informar a descrição da Grupo de Produtos. | |
| ativo | enum[SIM,NAO] | Informar se ativo ou não |
URI Parameters
- id
number(required) Example: 123Id da Grupo Produto
DELETE https://open-api.eprom.com.br/api/Produto/Grupo/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Grupo do produto excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Grupo ProdutoDELETE/Produto/Grupo/{id}
Processo de Exclusão de uma Grupo Produto do Produto.
URI Parameters
- id
number(required) Example: 123Id da Grupo Produto
Linha Produtos ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto/Linha
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"linha": "Linha",
"descricao": "Teste de Linha"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"linha": {
"type": "string",
"maxLength": 10,
"description": "Linha Produto."
},
"descricao": {
"type": "string",
"maxLength": 60,
"description": "Descrição do Linha Produtos."
}
},
"required": [
"linha",
"descricao"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 161,
"linha": "Linha",
"descricao": "Teste de Linha",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Linha ProdutoPOST/Produto/Linha
Processo de Criação de uma linha de Produtos. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| linha | ✔️ | String(10) | Informar a Sigla da Linha Produtos. |
| descricao | ✔️ | String(60) | Informar a descrição da Linha Produtos. |
GET https://open-api.eprom.com.br/api/Produto/Linha?id=123&linha=Linha&descricao=Descrição linha&ativo=SIM&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 30,
"data": [
{
"id": 1,
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA",
"ativo": "SIM"
},
{
"id": 2,
"linha": "01",
"descricao": "MATERIA PRIMA",
"ativo": "SIM"
},
{
"id": 3,
"linha": "03",
"descricao": "EMBALAGEM",
"ativo": "SIM"
},
{
"id": 4,
"linha": "04",
"descricao": "PRODUTO ACABADO",
"ativo": "SIM"
},
{
"id": 5,
"linha": "05",
"descricao": "SUBPRODUTO",
"ativo": "SIM"
},
{
"id": 6,
"linha": "06",
"descricao": "PRODUTO INTERMEDIARIO",
"ativo": "SIM"
},
{
"id": 7,
"linha": "07",
"descricao": "MATERIAL DE USO E CONSUMO",
"ativo": "SIM"
},
{
"id": 8,
"linha": "08",
"descricao": "ATIVO IMOBILIZADO",
"ativo": "SIM"
},
{
"id": 9,
"linha": "09",
"descricao": "SERVICOS",
"ativo": "SIM"
},
{
"id": 10,
"linha": "10",
"descricao": "OUTROS INSUMOS",
"ativo": "SIM"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Unidades MedidasGET/Produto/Linha{?id,linha,descricao,ativo,page,size}
Lista Unidades de Medidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Linha Produtos pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- linha
string(optional) Example: LinhaSe informada Linha, buscará a Linha Produtos por esse código. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: Descrição linhaDescrição da Linha Produtos ou parte dela .
- ativo
string(optional) Example: SIMIndicar se ativo.
Choices:
SIMNAO- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/Linha/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"linha": "Linha",
"descricao": "linha de Teste",
"ativo": "SIM"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"linha": {
"type": "string",
"maxLength": 10,
"description": "Linha Produtos."
},
"descricao": {
"type": "string",
"maxLength": 60,
"description": "Descrição da Linha Produtos."
},
"ativo": {
"enum": [
"SIM",
"NAO"
],
"description": "Ativo ou Inativa."
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 161,
"linha": "Linha",
"descricao": "Teste de Linha",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Linha ProdutoPUT/Produto/Linha/{id}
Processo de Alteração da Linha Produtos.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| linha | String(10) | Informar a Linha Produtos. | |
| descricao | String(60) | Informar a descrição da Linha Produtos. | |
| ativo | enum[SIM,NAO] | Informar se ativo ou não |
URI Parameters
- id
number(required) Example: 123Id da linha Produto
DELETE https://open-api.eprom.com.br/api/Produto/Linha/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "linha do produto excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Linha ProdutoDELETE/Produto/Linha/{id}
Processo de Exclusão de uma Linha do Produto.
URI Parameters
- id
number(required) Example: 123Id da Linha Produto
Marca Produtos ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto/Marca
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"marca": "Marca",
"descricao": "marca Teste"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"marca": {
"type": "string",
"maxLength": 30,
"description": "Marca Produto."
},
"descricao": {
"type": "string",
"maxLength": 60,
"description": "Descrição do Marca Produtos."
}
},
"required": [
"marca",
"descricao"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 94,
"marca": "Marca",
"descricao": "Teste de Marca",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Marca ProdutoPOST/Produto/Marca
Processo de Criação de uma marca de Produtos. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| marca | ✔️ | String(30) | Informar a Sigla da Marca Produtos. |
| descricao | ✔️ | String(60) | Informar a descrição da Marca Produtos. |
GET https://open-api.eprom.com.br/api/Produto/Marca?id=123&marca=Marca&descricao=Descrição marca&ativo=SIM&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 92,
"data": [
{
"id": 1,
"marca": "BOSCH",
"descricao": "Bosch do Brasil",
"ativo": "SIM"
},
{
"id": 2,
"marca": "NÃO ESPECIFICADO",
"descricao": "NÃO ESPECIFICADO",
"ativo": "SIM"
},
{
"id": 3,
"marca": "CHIAPERINI",
"descricao": "CHIAPERINI",
"ativo": "SIM"
},
{
"id": 4,
"marca": "ARBRAS",
"descricao": "ARBRAS",
"ativo": "SIM"
},
{
"id": 5,
"marca": "BELZER",
"descricao": "BELZER",
"ativo": "SIM"
},
{
"id": 6,
"marca": "ABS",
"descricao": "ABS",
"ativo": "SIM"
},
{
"id": 7,
"marca": "LUPUS",
"descricao": "LUPUS",
"ativo": "SIM"
},
{
"id": 8,
"marca": "DANFOSS",
"descricao": "DANFOSS",
"ativo": "SIM"
},
{
"id": 9,
"marca": "SIEMENS",
"descricao": "SIEMENS",
"ativo": "SIM"
},
{
"id": 10,
"marca": "LOCTITE",
"descricao": "LOCTITE",
"ativo": "SIM"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Unidades MedidasGET/Produto/Marca{?id,marca,descricao,ativo,page,size}
Lista Unidades de Medidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Marca Produtos pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- marca
string(optional) Example: MarcaMarca de produto ou parte dela.
- descricao
string(optional) Example: Descrição marcaDescrição da Marca Produtos ou parte dela .
- ativo
string(optional) Example: SIMIndicar se ativo.
Choices:
SIMNAO- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/Marca/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"marca": "Marca",
"descricao": "marca de Teste",
"ativo": "SIM"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"marca": {
"type": "string",
"maxLength": 30,
"description": "Marca Produtos."
},
"descricao": {
"type": "string",
"maxLength": 60,
"description": "Descrição da Marca Produtos."
},
"ativo": {
"enum": [
"SIM",
"NAO"
],
"description": "Ativo ou Inativa."
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 94,
"marca": "Marca",
"descricao": "Teste de Marca",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Marca ProdutoPUT/Produto/Marca/{id}
Processo de Alteração da Marca Produtos.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| marca | String(10) | Informar a Marca Produtos. | |
| descricao | String(60) | Informar a descrição da Marca Produtos. | |
| ativo | enum[SIM,NAO] | Informar se ativo ou não |
URI Parameters
- id
number(required) Example: 123Id da marca Produto
DELETE https://open-api.eprom.com.br/api/Produto/Marca/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Marca do produto excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Marca ProdutoDELETE/Produto/Marca/{id}
Processo de Exclusão de uma Marca do Produto.
URI Parameters
- id
number(required) Example: 123Id da Marca Produto
Origem Tributária ¶
Endpoints relativos à Origem Tributária de produtos.
GET https://open-api.eprom.com.br/api/Produto/OrigemTributaria?id=123&codigo=12345678&descricao=Produto&origem=12345678&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 10,
"data": [
{
"id": 1,
"codigo": 0,
"descricao": "FABRICADA",
"origem": "FABRICADO"
},
{
"id": 2,
"codigo": 0,
"descricao": "INDUSTRIALIZADA",
"origem": "FABRICADO"
},
{
"id": 3,
"codigo": 0,
"descricao": "NACIONAL",
"origem": "COMPRADO"
},
{
"id": 4,
"codigo": 1,
"descricao": "ESTRANGEIRA - IMPORTAÇÃO DIRETA",
"origem": "COMPRADO"
},
{
"id": 5,
"codigo": 2,
"descricao": "ESTRANGEIRA - ADIQ. MERC. INTERNO",
"origem": "COMPRADO"
},
{
"id": 9,
"codigo": 6,
"descricao": "ESTRANGEIRA IMPORTADA DIR. S/ SIMILAR NACIONAL",
"origem": "COMPRADO"
},
{
"id": 11,
"codigo": 8,
"descricao": "IMPORTADA SUP.70%",
"origem": "COMPRADO"
},
{
"id": 12,
"codigo": 0,
"descricao": "NACIONAL (C/ST)",
"origem": "COMPRADO"
},
{
"id": 24,
"codigo": 4,
"descricao": "ADICIONADO PELA IMPORTACAO DE XML",
"origem": "COMPRADO"
},
{
"id": 25,
"codigo": 0,
"descricao": "NACIONAL - tipo x",
"origem": "COMPRADO"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Origens Tributárias - ListarGET/Produto/OrigemTributaria{?id,codigo,descricao,origem,page,size}
Lista Origens Tributárias.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a Origem Tributária do Produtos pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- codigo
number(optional) Example: 12345678Código da Origem Tributária. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: ProdutoDescrição da Origem Tributária de Produtos ou parte dela.
- origem
number(optional) Example: 12345678Origem Tributária do Produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
Produto ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"descricao_reduzida": "Produto de teste",
"descricao_completa": "Produto de teste",
"entidade_id": 125,
"celinha_id": 1,
"cegrupo_id": 1,
"cemarca_id": 1,
"cfiscal_id": 1,
"origem_tributaria_id": 1,
"unidade_medida_id": 2,
"referencia": "000002",
"codigo": "000001",
"cdbarra": "0201201520316235152311203",
"peso": 15,
"volume": 10,
"altura": 2,
"largura": 2,
"comprimento": 1,
"lotemin": 1,
"lotemult": 10,
"estmin": 2,
"estmax": 200,
"cest": "123123",
"Imagens": [
"http://imagem1.com",
"http://imagem2.com",
"http://imagem3.com"
],
"preco": 15,
"custo": 5.5,
"saldo": 100
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/prod-post.defs.json",
"type": "object",
"additionalProperties": false,
"properties": {
"descricao_reduzida": {
"type": "string",
"description": "Descrição reduzida do produto"
},
"descricao_completa": {
"type": "string",
"description": "Descrição completa do produto"
},
"entidade_id": {
"type": "integer",
"description": "ID da entidade que possui vínculo com o produto."
},
"celinha_id": {
"type": "integer",
"description": "ID da linha do produto."
},
"cegrupo_id": {
"type": "integer",
"description": "ID do grupo do produto."
},
"cemarca_id": {
"type": "integer",
"description": "ID da marca do produto."
},
"cfiscal_id": {
"type": "integer",
"description": "ID da classificação do produto."
},
"origem_tributaria_id": {
"type": "integer",
"description": "ID da origem tributária do produto."
},
"unidade_medida_id": {
"type": "integer",
"description": "ID da unidade de medida do produto."
},
"referencia": {
"type": "string",
"description": "Código de referência do produto",
"maxLength": 30
},
"codigo": {
"type": "string",
"description": "Código de referência do produto",
"maxLength": 30
},
"cdbarra": {
"type": "string",
"description": "Código de barras do produto",
"maxLength": 20
},
"peso": {
"type": "number",
"description": "Peso do produto"
},
"volume": {
"type": "number",
"description": "Volume do produto"
},
"altura": {
"type": "number",
"description": "Altura do produto"
},
"largura": {
"type": "number",
"description": "Largura do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento do produto"
},
"lotemin": {
"type": "number",
"description": "Comprimento do produto"
},
"lotemult": {
"type": "number",
"description": "Comprimento do produto"
},
"estmin": {
"type": "number",
"description": "Comprimento do produto"
},
"estmax": {
"type": "number",
"description": "Comprimento do produto"
},
"cest": {
"type": "integer",
"description": "Código CEST do produto"
},
"Imagens": {
"type": "array",
"items": {
"type": "string"
},
"description": "Imagens dos produtos - Urls das Imagens"
},
"margem": {
"type": "number",
"description": "Margem para precificar o produto"
},
"preco": {
"type": "number",
"description": "Preço do produto"
},
"custo": {
"type": "number",
"description": "Custo do produto"
},
"saldo": {
"type": "number",
"description": "Saldo do produto"
}
},
"anyOf": [
{
"required": [
"descricao_reduzida"
]
},
{
"required": [
"descricao_completa"
]
}
],
"oneOf": [
{
"required": [
"preco"
]
},
{
"required": [
"margem"
]
}
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 124541,
"referencia": "000002",
"codigo": "000001",
"cdbarra": "1234567890123",
"descricao_reduzida": "Produto de teste",
"descricao_completa": "Produto de teste",
"preco": 5.555,
"custo": 5.5,
"saldo": 0,
"peso": 15,
"volume": 10,
"altura": 2,
"largura": 2,
"comprimento": 1,
"lotemin": 1,
"lotemult": 10,
"estmin": 2,
"estmax": 200,
"cest": 123123,
"dtcad": "2024-10-22",
"ativo": "SIM",
"Imagens": [
{
"id": 136,
"url": "http://imagem1.com",
"sequencia": 2
},
{
"id": 137,
"url": "http://imagem2.com",
"sequencia": 2
},
{
"id": 138,
"url": "http://imagem3.com",
"sequencia": 2
}
],
"Descricoes": [
{
"id": 263207,
"tipo": "REDUZIDA",
"descricao": "Produto de teste"
},
{
"id": 263208,
"tipo": "COMPLETA",
"descricao": "Produto de teste"
}
],
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"UnidadeMedida": {
"id": 2,
"ativo": "SIM",
"sigla": "CX",
"descricao": "CAIXA"
},
"Linha": {
"id": 1,
"ativo": "SIM",
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA"
},
"Marca": {
"id": 1,
"ativo": "SIM",
"marca": "BOSCH",
"descricao": "Bosch do Brasil"
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 1,
"ncm": 99999999,
"descricao": "PRESTAÇÂO DE SERVIÇO"
},
"OrigemTributaria": {
"id": 1,
"codigo": 0,
"origem": "FABRICADO",
"descricao": "FABRICADA"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação ProdutoPOST/Produto
Processo de Criação de Produto. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| descricao_reduzida | ✔️ | Texto | Descrição Reduzida do produto. |
| descricao_completa | ✔️ | Texto | Descrição Completa do produto. |
| entidade_id | Inteiro | Id da Entidade caso o produto esteja vinculado a ela. | |
| celinha_id | Inteiro | Id da linha de produto | |
| cegrupo_id | Inteiro | Id do grupo de produto | |
| cemarca_id | Inteiro | Id da marca do produto | |
| cfiscal_id | Inteiro | Id da classificação fiscal | |
| origem_tributaria_id | Inteiro | Id da origem tributária | |
| unidade_medida_id | Inteiro | Id da unidade de medida | |
| referencia | String(30) | Código de referência do produto | |
| codigo | String(30) | Código próprio do produto | |
| cdbarra | String(20) | Código de Barras do produto | |
| peso | Number | Peso do produto | |
| volume | Number | Volume do produto | |
| altura | Number | Altura do produto | |
| largura | Number | Largura do produto | |
| comprimento | Number | Comprimento do produto | |
| lotemin | Number | Lote mínimo do produto | |
| lotemult | Number | Lote Múltiplo do produto | |
| estmin | Number | Estoque Mínimo do produto | |
| estmax | Number | Estoque Máximo do produto | |
| cest | Number | Código CEST do produto | |
| Imagens | String(255)[] | Vetor com os endereços das imagens do produto | |
| preco | number | Preço do produto, se informado, não informar margem. | |
| margem | number | Margem do produto, se informado, não informar preço. | |
| custo | number | Custo do produto | |
| saldo | number | Saldo do produto |
GET https://open-api.eprom.com.br/api/Produto?id=123&descricao=descricao&preco=1.12&custo=1.00&saldo=1.00&entidade_id=1&celinha_id=1&cegrupo_id=1&cemarca_id=1&cfiscal_id=1&origem_tributaria_id=1&referencia=1&codigo=1&cdbarra=1&cest=1&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 24271,
"data": [
{
"id": 1,
"referencia": "000001",
"codigo": null,
"cdbarra": "12345677",
"descricao_reduzida": "Caneta bic",
"descricao_completa": "Caneta Bic",
"preco": 11.88,
"custo": 3,
"saldo": 81,
"peso": 0.1,
"volume": 5,
"altura": 20,
"largura": 0,
"comprimento": 0,
"lotemin": null,
"lotemult": null,
"estmin": null,
"estmax": null,
"cest": null,
"dtcad": "2023-10-02",
"ativo": "SIM",
"Imagens": [
{
"id": 18,
"url": "http://midias.eprom.com.br/imagem/28cae2f922dc07c11e9d7a287b1cba0e1c3b6a7299a605b3a42821a6f8b1d1dae994beb99e1eae9222ea73223469e5688618c09aadbfb010d427a24d26ff3c10fb64c1bac3e02d965aa002f2048268c83d90b9c001173d84eb2576f26c9c6715",
"sequencia": 20
},
{
"id": 94,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/7e1afca09a1440754d8395836cfc01df9ee1867d47ad9b61c055176ec8efbcb582ebbd1a461bf559537cfee4baf98b2a80eadcff379622122eec40ebb1c08e584c75da1448e3918a8af1ad73d0ce69083d90b9c001173d84eb2576f26c9c6715",
"sequencia": 10
},
{
"id": 112,
"url": "https://cdn.pixabay.com/photo/2024/02/26/19/39/monochrome-image-8598798_640.jpg",
"sequencia": 80
},
{
"id": 113,
"url": "https://cdn.pixabay.com/photo/2024/02/26/19/39/monochrome-image-8598798_640.jpg",
"sequencia": 40
},
{
"id": 114,
"url": "https://cdn.pixabay.com/photo/2024/02/26/19/39/monochrome-image-8598798_640.jpg",
"sequencia": 50
}
],
"Descricoes": [
{
"id": 1,
"tipo": "COMPLETA",
"descricao": "Caneta Bic"
},
{
"id": 2,
"tipo": "REDUZIDA",
"descricao": "Caneta bic"
}
],
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"UnidadeMedida": {
"id": 1,
"ativo": "SIM",
"sigla": "UNID",
"descricao": "UNIDADE"
},
"Linha": {
"id": 4,
"ativo": "SIM",
"linha": "04",
"descricao": "PRODUTO ACABADO"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 5689,
"ncm": 48209000,
"descricao": "Outros artigos de papel/cartão, para escritório/papelaria, etc"
},
"OrigemTributaria": {
"id": 1,
"codigo": 0,
"origem": "FABRICADO",
"descricao": "FABRICADA"
}
},
{
"id": 2,
"referencia": "000002",
"codigo": null,
"cdbarra": null,
"descricao_reduzida": "Pasta Arquivo De Plastico Amarela",
"descricao_completa": "Pasta Arquivo De Plastico Amarela",
"preco": 3.08,
"custo": 0,
"saldo": 2939,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": null,
"lotemult": null,
"estmin": null,
"estmax": null,
"cest": null,
"dtcad": "2019-02-15",
"ativo": "SIM",
"Imagens": [
{
"id": 88,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/47b286b53b883b68f18f0e480b11841288646db9ba157b1ca7b43f2e632764d751616a52299d98000560a8fd4c2e8d943d7eb19c4b2d1ff70215d081690a4160ea9aeae0892f9999b44fc8e56c78bfdb3d90b9c001173d84eb2576f26c9c6715",
"sequencia": 3
},
{
"id": 89,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/b8d0131f2e0da630b566dbee7f6ff74985d7c6da3e81a39ce18ebf361a47e610378d9d9b08ae517ccad6a6302530cf4f41994fc606e99b4fd0ea3e545688cd7c5f5e7e8ed53c183de6349732279258d2031fb0367383cdbf12899f1a0fa49679",
"sequencia": 2
},
{
"id": 90,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/3aa2d4ac3e85bbfb56f971848a15a34b232d2b4c4e75664da680bb3c0bbcd2828ad192a1c74f76c1dce607dd0775d1a95af60437ebc9057142c6e35039b655c08e9fd11d554c92bca80c8cff496f8013031fb0367383cdbf12899f1a0fa49679",
"sequencia": null
},
{
"id": 91,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/aee1af6cae5ffb5bdf23678cf054e5f46bb95451b101549028bfc08dd41bd5e1408958adb1f1c033f8bcd6d3f4889abb554f6ebb3f7f390bee253b77884743513312a1170583a4467cc965783c147e4d3d90b9c001173d84eb2576f26c9c6715",
"sequencia": null
},
{
"id": 92,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/c47f1c2f15ed8bc1e818fbb31f31259f406c6aad75ae112e35ef2eb09fd7464f3912b83f6df3d58bdc23a0a01496cd525789d5d2535b38bcc3b84a35436525e70fa3d914d8af38465dbbf569e915dbfc3d90b9c001173d84eb2576f26c9c6715",
"sequencia": null
},
{
"id": 93,
"url": "https://epromti-php-midias.azurewebsites.net/imagem/b8d0131f2e0da630b566dbee7f6ff7494e49d601429514237e1c5c11b1f3db9148901465e396ed0d907cdb2df3e6a1fc20c840d54ed6114f62379b6faa12aee85e1dc3a13eacebc2710ab654241a3e343d90b9c001173d84eb2576f26c9c6715",
"sequencia": 1
}
],
"Descricoes": [
{
"id": 3,
"tipo": "COMPLETA",
"descricao": "Pasta Arquivo De Plastico Amarela"
},
{
"id": 4,
"tipo": "REDUZIDA",
"descricao": "Pasta Arquivo De Plastico Amarela"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 1,
"ativo": "SIM",
"sigla": "UNID",
"descricao": "UNIDADE"
},
"Linha": {
"id": 1,
"ativo": "SIM",
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA"
},
"Marca": {
"id": 1,
"ativo": "SIM",
"marca": "BOSCH",
"descricao": "Bosch do Brasil"
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 5689,
"ncm": 48209000,
"descricao": "Outros artigos de papel/cartão, para escritório/papelaria, etc"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 3,
"referencia": "000003",
"codigo": null,
"cdbarra": null,
"descricao_reduzida": "Abridor De Garrafas",
"descricao_completa": "Abridor De Garrafas",
"preco": 16.5,
"custo": 0,
"saldo": 5,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": null,
"lotemult": null,
"estmin": null,
"estmax": null,
"cest": null,
"dtcad": "2021-11-19",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 177585,
"tipo": "COMPLETA",
"descricao": "Abridor De Garrafas"
},
{
"id": 177586,
"tipo": "REDUZIDA",
"descricao": "Abridor De Garrafas"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 1,
"ativo": "SIM",
"sigla": "UNID",
"descricao": "UNIDADE"
},
"Linha": {
"id": 4,
"ativo": "SIM",
"linha": "04",
"descricao": "PRODUTO ACABADO"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 9,
"ativo": "SIM",
"grupo": "60",
"descricao": "ACESSÓRIOS"
},
"ClassificacaoFiscal": {
"id": 1,
"ncm": 99999999,
"descricao": "PRESTAÇÂO DE SERVIÇO"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 8,
"referencia": "000008",
"codigo": null,
"cdbarra": null,
"descricao_reduzida": "Pigmento Branco 1000/6025 - Karina",
"descricao_completa": "Pigmento Branco 1000/6025 - Karina",
"preco": 18.795,
"custo": 8.95,
"saldo": 13497,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": null,
"lotemult": null,
"estmin": null,
"estmax": null,
"cest": null,
"dtcad": "2019-02-21",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 9,
"tipo": "COMPLETA",
"descricao": "Pigmento Branco 1000/6025 - Karina"
},
{
"id": 10,
"tipo": "REDUZIDA",
"descricao": "Pigmento Branco 1000/6025 - Karina"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 3,
"ativo": "SIM",
"sigla": "KG",
"descricao": "QUILOGRAMA"
},
"Linha": {
"id": 2,
"ativo": "SIM",
"linha": "01",
"descricao": "MATERIA PRIMA"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 4814,
"ncm": 39012029,
"descricao": "Outros polietilenos sem carga, densidade >= 0.94, em formas primárias"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 9,
"referencia": "000009",
"codigo": null,
"cdbarra": "0",
"descricao_reduzida": "Polietileno Alta Dens. Es-6004 (braskem)",
"descricao_completa": "Polietileno Alta Dens. Es-6004 (braskem)",
"preco": 13.75,
"custo": 0,
"saldo": 0,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": 0,
"lotemult": 0,
"estmin": 0,
"estmax": 0,
"cest": null,
"dtcad": "2019-02-21",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 11,
"tipo": "COMPLETA",
"descricao": "Polietileno Alta Dens. Es-6004 (braskem)"
},
{
"id": 12,
"tipo": "REDUZIDA",
"descricao": "Polietileno Alta Dens. Es-6004 (braskem)"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 3,
"ativo": "SIM",
"sigla": "KG",
"descricao": "QUILOGRAMA"
},
"Linha": {
"id": 1,
"ativo": "SIM",
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 2,
"ativo": "SIM",
"grupo": "002",
"descricao": "PAPELARIA"
},
"ClassificacaoFiscal": {
"id": 4814,
"ncm": 39012029,
"descricao": "Outros polietilenos sem carga, densidade >= 0.94, em formas primárias"
},
"OrigemTributaria": {
"id": 12,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL (C/ST)"
}
},
{
"id": 10,
"referencia": "000010",
"codigo": null,
"cdbarra": "0",
"descricao_reduzida": "Saco Plastico P/ Caixa 0,95 X 1,10mt",
"descricao_completa": "Saco Plastico P/ Caixa 0,95 X 1,10mt",
"preco": 5.78,
"custo": 0,
"saldo": 18,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": 0,
"lotemult": 0,
"estmin": 0,
"estmax": 0,
"cest": null,
"dtcad": "2019-02-21",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 13,
"tipo": "COMPLETA",
"descricao": "Saco Plastico P/ Caixa 0,95 X 1,10mt"
},
{
"id": 14,
"tipo": "REDUZIDA",
"descricao": "Saco Plastico P/ Caixa 0,95 X 1,10mt"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 1,
"ativo": "SIM",
"sigla": "UNID",
"descricao": "UNIDADE"
},
"Linha": {
"id": 2,
"ativo": "SIM",
"linha": "01",
"descricao": "MATERIA PRIMA"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 5098,
"ncm": 39232990,
"descricao": "Outros sacos, bolsas e cartuchos, de outros plásticos"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 15,
"referencia": "000015",
"codigo": null,
"cdbarra": "0",
"descricao_reduzida": "Fr Carolina 75gr",
"descricao_completa": "Fr Carolina 75gr",
"preco": 44,
"custo": 0,
"saldo": 5,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": 0,
"lotemult": 0,
"estmin": 0,
"estmax": 0,
"cest": null,
"dtcad": "2019-02-21",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 23,
"tipo": "COMPLETA",
"descricao": "Fr Carolina 75gr"
},
{
"id": 24,
"tipo": "REDUZIDA",
"descricao": "Fr Carolina 75gr"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 13,
"ativo": "SIM",
"sigla": "MIL",
"descricao": "ADICIONADO PELA IMPORTACAO DE XML"
},
"Linha": {
"id": 1,
"ativo": "SIM",
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 5099,
"ncm": 39233000,
"descricao": "Garrafões, garrafas, frascos, artigos semelhantes, de plásticos"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 16,
"referencia": "000016",
"codigo": null,
"cdbarra": "0",
"descricao_reduzida": "Fr Carolina 160gr",
"descricao_completa": "Fr Carolina 160gr",
"preco": 46.53,
"custo": 0,
"saldo": 150,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": 50,
"lotemult": 10,
"estmin": 0,
"estmax": 0,
"cest": null,
"dtcad": "2019-02-21",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 25,
"tipo": "COMPLETA",
"descricao": "Fr Carolina 160gr"
},
{
"id": 26,
"tipo": "REDUZIDA",
"descricao": "Fr Carolina 160gr"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 13,
"ativo": "SIM",
"sigla": "MIL",
"descricao": "ADICIONADO PELA IMPORTACAO DE XML"
},
"Linha": {
"id": 1,
"ativo": "SIM",
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 5099,
"ncm": 39233000,
"descricao": "Garrafões, garrafas, frascos, artigos semelhantes, de plásticos"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 17,
"referencia": "000017",
"codigo": null,
"cdbarra": "0",
"descricao_reduzida": "Frasco 160gr Producao Propria",
"descricao_completa": "Frasco 160gr Producao Propria",
"preco": 3.8,
"custo": 0,
"saldo": -70000,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": 0,
"lotemult": 0,
"estmin": 0,
"estmax": 0,
"cest": null,
"dtcad": "2019-02-22",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 27,
"tipo": "COMPLETA",
"descricao": "Frasco 160gr Producao Propria"
},
{
"id": 28,
"tipo": "REDUZIDA",
"descricao": "Frasco 160gr Producao Propria"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 1,
"ativo": "SIM",
"sigla": "UNID",
"descricao": "UNIDADE"
},
"Linha": {
"id": 3,
"ativo": "SIM",
"linha": "03",
"descricao": "EMBALAGEM"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 5099,
"ncm": 39233000,
"descricao": "Garrafões, garrafas, frascos, artigos semelhantes, de plásticos"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
},
{
"id": 18,
"referencia": "000018",
"codigo": null,
"cdbarra": "0",
"descricao_reduzida": "Serviço De Limpeza Testet",
"descricao_completa": "Serviço De Limpeza",
"preco": 110,
"custo": 0,
"saldo": -5,
"peso": 0,
"volume": 0,
"altura": 0,
"largura": 0,
"comprimento": 0,
"lotemin": 0,
"lotemult": 0,
"estmin": 0,
"estmax": 0,
"cest": null,
"dtcad": "2019-06-19",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 29,
"tipo": "COMPLETA",
"descricao": "Serviço De Limpeza"
},
{
"id": 30,
"tipo": "REDUZIDA",
"descricao": "Serviço De Limpeza Testet"
}
],
"Entidade": {
"id": null,
"nome": null
},
"UnidadeMedida": {
"id": 1,
"ativo": "SIM",
"sigla": "UNID",
"descricao": "UNIDADE"
},
"Linha": {
"id": 9,
"ativo": "SIM",
"linha": "09",
"descricao": "SERVICOS"
},
"Marca": {
"id": null,
"ativo": null,
"marca": null,
"descricao": null
},
"Grupo": {
"id": 2,
"ativo": "SIM",
"grupo": "002",
"descricao": "PAPELARIA"
},
"ClassificacaoFiscal": {
"id": 1,
"ncm": 99999999,
"descricao": "PRESTAÇÂO DE SERVIÇO"
},
"OrigemTributaria": {
"id": 3,
"codigo": 0,
"origem": "COMPRADO",
"descricao": "NACIONAL"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar ProdutosGET/Produto{?id,descricao,preco,custo,saldo,entidade_id,celinha_id,cegrupo_id,cemarca_id,cfiscal_id,origem_tributaria_id,referencia,codigo,cdbarra,cest,page,size}
Lista produtos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a entidade pelo id.
- descricao
string(optional) Example: descricaoPode ser informado parte da string.
- preco
number(optional) Example: 1.12Pode ser informado o preço para ser pesquisado. Esse parâmetro permite valor inicial e valor final na pesquisa, basta separar os valores por vírgula. Ex: 12.5,15.6
- custo
number(optional) Example: 1.00Pode ser informado o custo para ser pesquisado. Esse parâmetro permite valor inicial e valor final na pesquisa, basta separar os valores por vírgula. Ex: 12.5,15.6
- saldo
number(optional) Example: 1.00Pode ser informado o saldo para ser pesquisado. Esse parâmetro permite valor inicial e valor final na pesquisa, basta separar os valores por vírgula. Ex: 12.5,15.6
- entidade_id
number(optional) Example: 1Pode ser informado o ID da entidade para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- celinha_id
number(optional) Example: 1Pode ser informado o ID da Linha para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- cegrupo_id
number(optional) Example: 1Pode ser informado o ID do Grupo para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- cemarca_id
number(optional) Example: 1Pode ser informado o ID da Marca para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- cfiscal_id
number(optional) Example: 1Pode ser informado o ID da Classificação Fiscal para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- origem_tributaria_id
number(optional) Example: 1Pode ser informado o ID da Origem Tributária para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- referencia
number(optional) Example: 1Pode ser informado a referência para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- codigo
number(optional) Example: 1Pode ser informado o código para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- cdbarra
number(optional) Example: 1Pode ser informado o código de barras ou parte dele para ser pesquisado.
- cest
number(optional) Example: 1Pode ser informado o CEST para ser pesquisado. Esse parâmetro permite vários valores desde que separados por vírgula.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"descricao_reduzida": "Produto de teste",
"descricao_completa": "Produto de teste",
"entidade_id": 125,
"celinha_id": 1,
"cegrupo_id": 1,
"cemarca_id": 1,
"cfiscal_id": 1,
"origem_tributaria_id": 1,
"unidade_medida_id": 2,
"referencia": "000002",
"codigo": "000001",
"cdbarra": "123456789123",
"peso": 15,
"volume": 10,
"altura": 2,
"largura": 2,
"comprimento": 1,
"lotemin": 1,
"lotemult": 10,
"estmin": 2,
"estmax": 200,
"cest": "123123",
"preco": 15,
"margem": 1,
"custo": 5.5
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/prod-post.defs.json",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"descricao_reduzida": {
"type": "string",
"description": "Descrição reduzida do produto"
},
"descricao_completa": {
"type": "string",
"description": "Descrição completa do produto"
},
"entidade_id": {
"type": "integer",
"description": "ID da entidade que possui vínculo com o produto."
},
"celinha_id": {
"type": "integer",
"description": "ID da linha do produto."
},
"cegrupo_id": {
"type": "integer",
"description": "ID do grupo do produto."
},
"cemarca_id": {
"type": "integer",
"description": "ID da marca do produto."
},
"cfiscal_id": {
"type": "integer",
"description": "ID da classificação do produto."
},
"origem_tributaria_id": {
"type": "integer",
"description": "ID da origem tributária do produto."
},
"unidade_medida_id": {
"type": "integer",
"description": "ID da unidade de medida do produto."
},
"referencia": {
"type": "string",
"description": "Código de referência do produto",
"maxLength": 30
},
"codigo": {
"type": "string",
"description": "Código de referência do produto",
"maxLength": 30
},
"cdbarra": {
"type": "string",
"description": "Código de barras do produto",
"maxLength": 20
},
"peso": {
"type": "number",
"description": "Peso do produto"
},
"volume": {
"type": "number",
"description": "Volume do produto"
},
"altura": {
"type": "number",
"description": "Altura do produto"
},
"largura": {
"type": "number",
"description": "Largura do produto"
},
"comprimento": {
"type": "number",
"description": "Comprimento do produto"
},
"lotemin": {
"type": "number",
"description": "Comprimento do produto"
},
"lotemult": {
"type": "number",
"description": "Comprimento do produto"
},
"estmin": {
"type": "number",
"description": "Comprimento do produto"
},
"estmax": {
"type": "number",
"description": "Comprimento do produto"
},
"cest": {
"type": "integer",
"description": "Código CEST do produto"
},
"margem": {
"type": "number",
"description": "Margem para precificar o produto"
},
"preco": {
"type": "number",
"description": "Preço do produto"
},
"custo": {
"type": "number",
"description": "Custo do produto"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 18,
"referencia": "000002",
"codigo": "000001",
"cdbarra": "123456789011",
"descricao_reduzida": "Serviço De Limpeza Testet",
"descricao_completa": "Serviço De Limpeza",
"preco": 15,
"custo": 5.5,
"saldo": -5,
"peso": 15,
"volume": 10,
"altura": 2,
"largura": 2,
"comprimento": 1,
"lotemin": 1,
"lotemult": 10,
"estmin": 2,
"estmax": 200,
"cest": 123123,
"dtcad": "2019-06-19",
"ativo": "SIM",
"Imagens": null,
"Descricoes": [
{
"id": 29,
"tipo": "COMPLETA",
"descricao": "Serviço De Limpeza"
},
{
"id": 30,
"tipo": "REDUZIDA",
"descricao": "Serviço De Limpeza Testet"
}
],
"Entidade": {
"id": 125,
"nome": "Eprom Ti Informática S/c Ltda - Azure"
},
"UnidadeMedida": {
"id": 2,
"ativo": "SIM",
"sigla": "CX",
"descricao": "CAIXA"
},
"Linha": {
"id": 1,
"ativo": "SIM",
"linha": "00",
"descricao": "MERCADORIA PARA REVENDA"
},
"Marca": {
"id": 1,
"ativo": "SIM",
"marca": "BOSCH",
"descricao": "Bosch do Brasil"
},
"Grupo": {
"id": 1,
"ativo": "SIM",
"grupo": "001",
"descricao": "DIVERSOS"
},
"ClassificacaoFiscal": {
"id": 1,
"ncm": 99999999,
"descricao": "PRESTAÇÂO DE SERVIÇO"
},
"OrigemTributaria": {
"id": 1,
"codigo": 0,
"origem": "FABRICADO",
"descricao": "FABRICADA"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração ProdutoPUT/Produto/{id}
Processo de Alteração do Produto.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| descricao_reduzida | Texto | Descrição Reduzida do produto. | |
| descricao_completa | Texto | Descrição Completa do produto. | |
| entidade_id | Inteiro | Id da Entidade caso o produto esteja vinculado a ela. | |
| celinha_id | Inteiro | Id da linha de produto | |
| cegrupo_id | Inteiro | Id do grupo de produto | |
| cemarca_id | Inteiro | Id da marca do produto | |
| cfiscal_id | Inteiro | Id da classificação fiscal | |
| origem_tributaria_id | Inteiro | Id da origem tributária | |
| unidade_medida_id | Inteiro | Id da unidade de medida | |
| referencia | String(30) | Código de referência do produto | |
| codigo | String(30) | Código próprio do produto | |
| cdbarra | String(20) | Código de Barras do produto | |
| peso | Number | Peso do produto | |
| volume | Number | Volume do produto | |
| altura | Number | Altura do produto | |
| largura | Number | Largura do produto | |
| comprimento | Number | Comprimento do produto | |
| lotemin | Number | Lote mínimo do produto | |
| lotemult | Number | Lote Múltiplo do produto | |
| estmin | Number | Estoque Mínimo do produto | |
| estmax | Number | Estoque Máximo do produto | |
| cest | Number | Código CEST do produto | |
| preco | number | Preço do produto, se informado, não informar margem. | |
| margem | number | Margem do produto, se informado, não informar preço. | |
| custo | number | Custo do produto |
URI Parameters
- id
number(required) Example: 123Id da Produto
DELETE https://open-api.eprom.com.br/api/Produto/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Produto excluído"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão ProdutoDELETE/Produto/{id}
Processo de Exclusão de Produto.
URI Parameters
- id
number(required) Example: 123Id do produto
Produto Descrição ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto/Descricao
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"produto_id": 123,
"tipo": "REDUZIDA",
"descricao": "Produto Descrição Reduzida"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"produto_id": {
"type": "number",
"description": "Id do Produto"
},
"tipo": {
"type": "string",
"enum": [
"REDUZIDA",
"COMPLETA",
"INGLES",
"ESPANHOL",
"ESPECIFICACAO"
],
"description": "Tipo da Descrição"
},
"descricao": {
"type": "string",
"description": "Descrição de acordo com o tipo escolhido"
}
},
"required": [
"produto_id",
"tipo",
"descricao"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 23,
"tipo": "COMPLETA",
"descricao": "Teste de descrição",
"Produto": {
"id": 15,
"referencia": "000015",
"codigo": null,
"ativo": "SIM"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação DescriçãoPOST/Produto/Descricao
Processo de Criação de Descrição de Produtos. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | ✔️ | Inteiro | ID do produto que deseja incluir a descrição. |
| tipo | ✔️ | TipoDescricaoProduto | Tipo da Descrição do produto. |
| descricao | ✔️ | Texto | Texto da Descrição. |
Tipos de dados usados:
Tipo de Pessoa
TipoDescricaoProduto
-
REDUZIDA
-
COMPLETA
-
INGLES
-
ESPANHOL
-
ESPECIFICACAO
TipoDescricaoProduto
-
REDUZIDA -
COMPLETA -
INGLES -
ESPANHOL -
ESPECIFICACAO
GET https://open-api.eprom.com.br/api/Produto/Descricao?id=123&produto_id=123&tipo=COMPLETA&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 48567,
"data": [
{
"id": 1,
"tipo": "COMPLETA",
"descricao": "Caneta Bic",
"Produto": {
"id": 1,
"referencia": "000001",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 2,
"tipo": "REDUZIDA",
"descricao": "Caneta bic",
"Produto": {
"id": 1,
"referencia": "000001",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 3,
"tipo": "COMPLETA",
"descricao": "Pasta Arquivo De Plastico Amarela",
"Produto": {
"id": 2,
"referencia": "000002",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 4,
"tipo": "REDUZIDA",
"descricao": "Pasta Arquivo De Plastico Amarela",
"Produto": {
"id": 2,
"referencia": "000002",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 9,
"tipo": "COMPLETA",
"descricao": "Pigmento Branco 1000/6025 - Karina",
"Produto": {
"id": 8,
"referencia": "000008",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 10,
"tipo": "REDUZIDA",
"descricao": "Pigmento Branco 1000/6025 - Karina",
"Produto": {
"id": 8,
"referencia": "000008",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 11,
"tipo": "COMPLETA",
"descricao": "Polietileno Alta Dens. Es-6004 (braskem)",
"Produto": {
"id": 9,
"referencia": "000009",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 12,
"tipo": "REDUZIDA",
"descricao": "Polietileno Alta Dens. Es-6004 (braskem)",
"Produto": {
"id": 9,
"referencia": "000009",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 13,
"tipo": "COMPLETA",
"descricao": "Saco Plastico P/ Caixa 0,95 X 1,10mt",
"Produto": {
"id": 10,
"referencia": "000010",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 14,
"tipo": "REDUZIDA",
"descricao": "Saco Plastico P/ Caixa 0,95 X 1,10mt",
"Produto": {
"id": 10,
"referencia": "000010",
"codigo": null,
"ativo": "SIM"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar DescriçõesGET/Produto/Descricao{?id,produto_id,tipo,descricao,page,size}
Lista descrições dos produtos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a entidade pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- produto_id
number(optional) Example: 123Se informado id, buscará a entidade pelo id do produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- tipo
string(optional) Example: COMPLETATipo de descrição. Pode ser um valor ou uma lista de valores separada por vírgula(,) Os valores possíveis são os seguintes:
REDUZIDA,COMPLETA,INGLES,ESPANHOL,ESPECIFICACAO.Choices:
REDUZIDACOMPLETAINGLESESPANHOLESPECIFICACAO- descricao
string(optional) Example: descricaoPode ser informado parte da string.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/Descricao/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"tipo": "COMPLETA"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"tipo": {
"type": "string",
"enum": [
"REDUZIDA",
"COMPLETA",
"INGLES",
"ESPANHOL",
"ESPECIFICACAO"
],
"description": "Tipo da Descrição"
},
"descricao": {
"type": "string",
"enum": [
"Produto Descrição Reduzida"
],
"description": "Descrição de acordo com o tipo escolhido"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 23,
"produto_id": 15,
"tipo": "COMPLETA",
"descricao": "Teste de descrição"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração DescriçãoPUT/Produto/Descricao/{id}
Processo de Alteração da Descrição do produto.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| tipo | TipoDescricaoProduto | Tipo da Descrição do produto. | |
| descricao | Texto | Texto da Descrição. |
URI Parameters
- id
number(required) Example: 123Id da descrição
DELETE https://open-api.eprom.com.br/api/Produto/Descricao/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Descrição do produto excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão DescriçãoDELETE/Produto/Descricao/{id}
Processo de Exclusão de uma descrição do Produto.
URI Parameters
- id
number(required) Example: 123Id da descrição
Produto Imagem ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto/Imagem
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"produto_id": 123,
"sequencia": 13,
"url": "http://minhaimagem.com"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"produto_id": {
"type": "number",
"description": "Id do Produto."
},
"sequencia": {
"type": "number",
"description": "Sequencial da imagem."
},
"url": {
"type": "string",
"description": "Url da imagem a ser vinculada."
}
},
"required": [
"produto_id",
"url"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Imagem cadastrada",
"data": {
"id": 142,
"sequencia": 1,
"url": "http://teste.com/image.png",
"Produto": {
"id": 15,
"referencia": "000015",
"codigo": null,
"ativo": "SIM"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação ImagemPOST/Produto/Imagem
Processo de Criação de Imagem de Produtos. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| produto_id | ✔️ | Inteiro | ID do produto que deseja incluir a Imagem. |
| sequencia | Inteiro | Sequencial da Imagem. | |
| url | ✔️ | Texto | Url da Imagem a ser vinculada ao produto. |
GET https://open-api.eprom.com.br/api/Produto/Imagem?id=123&produto_id=123&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 51,
"data": [
{
"id": 1,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/28cae2f922dc07c11e9d7a287b1cba0e1c3b6a7299a605b3a42821a6f8b1d1dae994beb99e1eae9222ea73223469e5688618c09aadbfb010d427a24d26ff3c10fb64c1bac3e02d965aa002f2048268c83d90b9c001173d84eb2576f26c9c6715",
"Produto": {
"id": 101,
"referencia": "2546723425",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 4,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/9a8700cdb9522812ae42faf54a74d7caff9bc78983dd464440a1cf30913ba3fbea67b66f54d8942f5cb2a56f692e90041b8322de24390a9d3dc6478c9e86268715ea9170f000de528667803587243c123d90b9c001173d84eb2576f26c9c6715\r\n",
"Produto": {
"id": 19,
"referencia": "000019",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 12,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/bf1fa33f081bfcb8d98dbebe46e6bf17884ca895ad343c211b8a0794d0b4e78cd2a7ad337e1b842b86c1f8abe570c8358e63be7b702aa7d0114c02f512194bade2a86a5f3d316a0a2f73e6f1f7bd0e453d90b9c001173d84eb2576f26c9c6715",
"Produto": {
"id": 194,
"referencia": "014276",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 14,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/a1acd58aef244f3400cb6e9b364e477b16f37ce62a56d0fd4e2fc8d8b2a0a460fd6148b20a75bb45e660a77176417e79b2eefd7f112e31c7431b7215967319e13e1cd9d9ccd523da7c65dff284687dfb3d90b9c001173d84eb2576f26c9c6715\r\n",
"Produto": {
"id": 302,
"referencia": "014534",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 15,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/c47f1c2f15ed8bc1e818fbb31f31259fc8045541ebb82ed28af45f20d79581f2220e6495611c402d491d98103fc27de32d3f22b94aa3d33faa4e622442bf6f581b42d908bef11079c8be92b92937e55f3d90b9c001173d84eb2576f26c9c6715\r\n",
"Produto": {
"id": 302,
"referencia": "014534",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 16,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/3d0eec27b6e7a55be03a103abe9507b68909f3822adebccc92443f0153625812096ac897423b3a940d8d3892d1d7059997ce93c81a8e05e254cf2db91eb6343b3a758e0f67b80d58f2a677d598b9f87c3d90b9c001173d84eb2576f26c9c6715\r\n",
"Produto": {
"id": 302,
"referencia": "014534",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 18,
"sequencia": 20,
"url": "http://midias.eprom.com.br/imagem/28cae2f922dc07c11e9d7a287b1cba0e1c3b6a7299a605b3a42821a6f8b1d1dae994beb99e1eae9222ea73223469e5688618c09aadbfb010d427a24d26ff3c10fb64c1bac3e02d965aa002f2048268c83d90b9c001173d84eb2576f26c9c6715",
"Produto": {
"id": 1,
"referencia": "000001",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 20,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/c47f1c2f15ed8bc1e818fbb31f31259fe5560b5599b39991a946321e46442069ee88b6f0001eb43c7cc7d25cb5a5a58b049b82d5c6dbae4ea08842175a2cee6ffda28e8274aeadb6e2a644a1ff61da163d90b9c001173d84eb2576f26c9c6715\r\n",
"Produto": {
"id": 19,
"referencia": "000019",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 21,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/c47f1c2f15ed8bc1e818fbb31f31259faccf5b3f6e818facd4804707e7dbb54dca853285ed842d2c1a1010f326dfb624c5e24873b43cc966807aae73dfe156ce69b94c551bfa9ac328973a510e917c663d90b9c001173d84eb2576f26c9c6715",
"Produto": {
"id": 307,
"referencia": "123458",
"codigo": null,
"ativo": "SIM"
}
},
{
"id": 22,
"sequencia": null,
"url": "http://midias.eprom.com.br/imagem/e6f3912ccc37d474fbec8aadf5e883c55f6285819632f01718a9bcdf6ade56ea26abaf3269fcc6ff215385e2727894bceb49fccffc7806c332ad3a7843a40fe1a1beb62fd91ce626063ea3f2518b8ebe3d90b9c001173d84eb2576f26c9c6715",
"Produto": {
"id": 307,
"referencia": "123458",
"codigo": null,
"ativo": "SIM"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar ImagensGET/Produto/Imagem{?id,produto_id,page,size}
Lista Imagens dos produtos.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a entidade pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- produto_id
number(optional) Example: 123Se informado id, buscará a entidade pelo id do produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/Imagem/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"sequencia": 1,
"url": "https://minhaimagem.com.br/imagem01.png"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"sequencia": {
"type": "integer",
"description": "Sequencial da Imagem"
},
"url": {
"type": "string",
"description": "Url da Imagem"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Imagem do produto atualizada",
"data": {
"id": 15,
"sequencia": 1,
"url": "http://midias.eprom.com.br/imagem/c47f1c2f15ed8bc1e818fbb31f31259fc8045541ebb82ed28af45f20d79581f2220e6495611c402d491d98103fc27de32d3f22b94aa3d33faa4e622442bf6f581b42d908bef11079c8be92b92937e55f3d90b9c001173d84eb2576f26c9c6715\r\n",
"Produto": {
"id": 302,
"referencia": "014534",
"codigo": null,
"ativo": "SIM"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração ImagemPUT/Produto/Imagem/{id}
Processo de Alteração do Produto.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| sequencia | Inteiro | Sequencial da imagem. | |
| url | Texto | Url da imagem. |
URI Parameters
- id
number(required) Example: 123Id da Imagem
DELETE https://open-api.eprom.com.br/api/Produto/Imagem/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Imagem do produto excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão ImagemDELETE/Produto/Imagem/{id}
Processo de Exclusão de uma Imagem do Produto.
URI Parameters
- id
number(required) Example: 123Id da Imagem
Unidade de Medida ¶
Endpoints relativos ao cadastro de produtos.
POST https://open-api.eprom.com.br/api/Produto/UnidadeMedida
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"sigla": "UN",
"descricao": "Unidade"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"sigla": {
"type": "string",
"maxLength": 10,
"description": "Sigla da unidade de medida."
},
"descricao": {
"type": "string",
"maxLength": 40,
"description": "Descrição da unidade de medida."
}
},
"required": [
"sigla",
"descricao"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 5922,
"sigla": "UN",
"descricao": "UNIDADE",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Unidade MedidaPOST/Produto/UnidadeMedida
Processo de Criação de uma Unidade Medida de Produtos. Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| sigla | ✔️ | String(10) | Informar a Sigla da unidade de medida. |
| descricao | ✔️ | String(40) | Informar a descrição da unidade de medida. |
GET https://open-api.eprom.com.br/api/Produto/UnidadeMedida?id=123&sigla=UN&descricao=Unidade&ativo=SIM&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 1028,
"data": [
{
"id": 4831,
"sigla": "AMPOLA",
"descricao": "AMPOLA",
"ativo": "SIM"
},
{
"id": 4832,
"sigla": "BALDE",
"descricao": "BALDE",
"ativo": "SIM"
},
{
"id": 4833,
"sigla": "BANDEJ",
"descricao": "BANDEJA",
"ativo": "SIM"
},
{
"id": 4834,
"sigla": "BARRA",
"descricao": "BARRA",
"ativo": "SIM"
},
{
"id": 4835,
"sigla": "BISNAG",
"descricao": "BISNAGA",
"ativo": "SIM"
},
{
"id": 4836,
"sigla": "BLOCO",
"descricao": "BLOCO",
"ativo": "SIM"
},
{
"id": 4837,
"sigla": "BOBINA",
"descricao": "BOBINA",
"ativo": "SIM"
},
{
"id": 4838,
"sigla": "BOMB",
"descricao": "BOMBONA",
"ativo": "SIM"
},
{
"id": 4839,
"sigla": "CAPS",
"descricao": "CAPSULA",
"ativo": "SIM"
},
{
"id": 4840,
"sigla": "CART",
"descricao": "CARTELA",
"ativo": "SIM"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Unidades MedidasGET/Produto/UnidadeMedida{?id,sigla,descricao,ativo,page,size}
Lista Unidades de Medidas.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a unidade de medida pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- sigla
string(optional) Example: UNSigla do produto. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: UnidadeDescrição da unidade de medida ou parte dela .
- ativo
string(optional) Example: SIMIndicar se ativo.
Choices:
SIMNAO- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/Produto/UnidadeMedida/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"sigla": "UN",
"descricao": "UNIDADE",
"ativo": "SIM"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"sigla": {
"type": "string",
"maxLength": 10,
"description": "Sigla da unidade de medida."
},
"descricao": {
"type": "string",
"maxLength": 40,
"description": "Descrição da unidade de medida."
},
"ativo": {
"enum": [
"SIM",
"NAO"
],
"description": "Ativo ou Inativa."
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 5922,
"sigla": "UN",
"descricao": "UNIDADE",
"ativo": "SIM"
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Unidade MedidaPUT/Produto/UnidadeMedida/{id}
Processo de Alteração da Unidade de Medida.
Os dados a serem enviados são os seguintes:
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| sigla | String(10) | Informar a Sigla da unidade de medida. | |
| descricao | String(40) | Informar a descrição da unidade de medida. | |
| ativo | enum[SIM,NAO] | Informar se ativo ou não |
URI Parameters
- id
number(required) Example: 123Id da Unidade Medida
DELETE https://open-api.eprom.com.br/api/Produto/UnidadeMedida/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Unidade de Medida excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão Unidade MedidaDELETE/Produto/UnidadeMedida/{id}
Processo de Exclusão de uma Unidade Medida do Produto.
URI Parameters
- id
number(required) Example: 123Id da Unidade Medida
Tabelas Apoio ¶
Nesse grupo iremos trabalhar as tabelas de apoio do sistema.
CNAE ¶
Endpoint relativo as Classes, Grupos, Seções do CNAE do sistema.
GET https://open-api.eprom.com.br/api/Entidade/Atividade/ClasseCnae?id=123&codigo=codigo&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 498,
"data": [
{
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 2,
"codigo": "01.12-1",
"descricao": "Horticultura e floricultura",
"GrupoCnae": {
"id": 2,
"codigo": "01.2",
"descricao": "Horticultura e floricultura",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 3,
"codigo": "01.13-0",
"descricao": "Produção de lavouras permanentes",
"GrupoCnae": {
"id": 3,
"codigo": "01.3",
"descricao": "Produção de lavouras permanentes",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 4,
"codigo": "01.14-8",
"descricao": "Produção de sementes e mudas certificadas",
"GrupoCnae": {
"id": 4,
"codigo": "01.4",
"descricao": "Produção de sementes e mudas certificadas",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 5,
"codigo": "01.15-6",
"descricao": "Pecuária",
"GrupoCnae": {
"id": 5,
"codigo": "01.5",
"descricao": "Pecuária",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 6,
"codigo": "01.16-4",
"descricao": "Atividades de apoio à agricultura e à pecuária; atividades de pós-colheita",
"GrupoCnae": {
"id": 6,
"codigo": "01.6",
"descricao": "Atividades de apoio à agricultura e à pecuária; atividades de pós-colheita",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 7,
"codigo": "01.19-9",
"descricao": "Caça e serviços relacionados",
"GrupoCnae": {
"id": 7,
"codigo": "01.7",
"descricao": "Caça e serviços relacionados",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 8,
"codigo": "01.21-1",
"descricao": "Produção florestal - florestas plantadas",
"GrupoCnae": {
"id": 8,
"codigo": "02.1",
"descricao": "Produção florestal - florestas plantadas",
"DivisaoCnae": {
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 9,
"codigo": "01.22-9",
"descricao": "Produção florestal - florestas nativas",
"GrupoCnae": {
"id": 9,
"codigo": "02.2",
"descricao": "Produção florestal - florestas nativas",
"DivisaoCnae": {
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
},
{
"id": 10,
"codigo": "01.31-8",
"descricao": "Atividades de apoio à produção florestal",
"GrupoCnae": {
"id": 10,
"codigo": "02.3",
"descricao": "Atividades de apoio à produção florestal",
"DivisaoCnae": {
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Classes do CNAEGET/Entidade/Atividade/ClasseCnae{?id,codigo,descricao,page,size}
Lista as Classes do CNAE do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a classe cnae pelo id.
- codigo
string(optional) Example: codigoSe informado, buscará por parte do código.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Entidade/Atividade/DivisaoCnae?id=123&codigo=codigo&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 87,
"data": [
{
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
},
{
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
},
{
"id": 3,
"codigo": "03",
"descricao": "PESCA E AQÜICULTURA",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
},
{
"id": 4,
"codigo": "05",
"descricao": "EXTRAÇÃO DE CARVÃO MINERAL",
"SecaoCnae": {
"id": 2,
"codigo": "B",
"descricao": "INDÚSTRIAS EXTRATIVAS"
}
},
{
"id": 5,
"codigo": "06",
"descricao": "EXTRAÇÃO DE PETRÓLEO E GÁS NATURAL",
"SecaoCnae": {
"id": 2,
"codigo": "B",
"descricao": "INDÚSTRIAS EXTRATIVAS"
}
},
{
"id": 6,
"codigo": "07",
"descricao": "EXTRAÇÃO DE MINERAIS METÁLICOS",
"SecaoCnae": {
"id": 2,
"codigo": "B",
"descricao": "INDÚSTRIAS EXTRATIVAS"
}
},
{
"id": 7,
"codigo": "08",
"descricao": "EXTRAÇÃO DE MINERAIS NÃO-METÁLICOS",
"SecaoCnae": {
"id": 2,
"codigo": "B",
"descricao": "INDÚSTRIAS EXTRATIVAS"
}
},
{
"id": 8,
"codigo": "09",
"descricao": "ATIVIDADES DE APOIO À EXTRAÇÃO DE MINERAIS",
"SecaoCnae": {
"id": 2,
"codigo": "B",
"descricao": "INDÚSTRIAS EXTRATIVAS"
}
},
{
"id": 9,
"codigo": "10",
"descricao": "FABRICAÇÃO DE PRODUTOS ALIMENTÍCIOS",
"SecaoCnae": {
"id": 3,
"codigo": "C",
"descricao": "INDÚSTRIAS DE TRANSFORMAÇÃO"
}
},
{
"id": 10,
"codigo": "11",
"descricao": "FABRICAÇÃO DE BEBIDAS",
"SecaoCnae": {
"id": 3,
"codigo": "C",
"descricao": "INDÚSTRIAS DE TRANSFORMAÇÃO"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Divisões do CNAEGET/Entidade/Atividade/DivisaoCnae{?id,codigo,descricao,page,size}
Lista as Divisões do CNAE do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a divisão do cnae pelo id.
- codigo
string(optional) Example: codigoSe informado, buscará por parte do código.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Entidade/Atividade/GrupoCnae?id=123&codigo=codigo&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 285,
"data": [
{
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 2,
"codigo": "01.2",
"descricao": "Horticultura e floricultura",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 3,
"codigo": "01.3",
"descricao": "Produção de lavouras permanentes",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 4,
"codigo": "01.4",
"descricao": "Produção de sementes e mudas certificadas",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 5,
"codigo": "01.5",
"descricao": "Pecuária",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 6,
"codigo": "01.6",
"descricao": "Atividades de apoio à agricultura e à pecuária; atividades de pós-colheita",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 7,
"codigo": "01.7",
"descricao": "Caça e serviços relacionados",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 8,
"codigo": "02.1",
"descricao": "Produção florestal - florestas plantadas",
"DivisaoCnae": {
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 9,
"codigo": "02.2",
"descricao": "Produção florestal - florestas nativas",
"DivisaoCnae": {
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
},
{
"id": 10,
"codigo": "02.3",
"descricao": "Atividades de apoio à produção florestal",
"DivisaoCnae": {
"id": 2,
"codigo": "02",
"descricao": "PRODUÇÃO FLORESTAL",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Grupos do CNAEGET/Entidade/Atividade/GrupoCnae{?id,codigo,descricao,page,size}
Lista as Grupo do CNAE do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o grupo do cnae pelo id.
- codigo
string(optional) Example: codigoSe informado, buscará por parte do código.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Entidade/Atividade/SecaoCnae?id=123&codigo=codigo&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 21,
"data": [
{
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
},
{
"id": 2,
"codigo": "B",
"descricao": "INDÚSTRIAS EXTRATIVAS"
},
{
"id": 3,
"codigo": "C",
"descricao": "INDÚSTRIAS DE TRANSFORMAÇÃO"
},
{
"id": 4,
"codigo": "D",
"descricao": "ELETRICIDADE E GÁS"
},
{
"id": 5,
"codigo": "E",
"descricao": "ÁGUA, ESGOTO, ATIVIDADES DE GESTÃO DE RESÍDUOS E DESCONTAMINAÇÃO"
},
{
"id": 6,
"codigo": "F",
"descricao": "CONSTRUÇÃO"
},
{
"id": 7,
"codigo": "G",
"descricao": "COMÉRCIO; REPARAÇÃO DE VEÍCULOS AUTOMOTORES E MOTOCICLETAS"
},
{
"id": 8,
"codigo": "H",
"descricao": "TRANSPORTE, ARMAZENAGEM E CORREIO"
},
{
"id": 9,
"codigo": "I",
"descricao": "ALOJAMENTO E ALIMENTAÇÃO"
},
{
"id": 10,
"codigo": "J",
"descricao": "INFORMAÇÃO E COMUNICAÇÃO"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Seções do CNAEGET/Entidade/Atividade/SecaoCnae{?id,codigo,descricao,page,size}
Lista as Seções do CNAE do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a seção do cnae pelo id.
- codigo
string(optional) Example: codigoSe informado, buscará por parte do código.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
Forma Pagamento ¶
Endpoint relativo as Formas de Pagamento do sistema.
POST https://open-api.eprom.com.br/api/FormaPagamento
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"modulo": "GERAL",
"descricao": "Teste 1",
"indicativo": "A VISTA",
"modalidade": "CHEQUE"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/form-pagto-post.defs.json",
"allOf": [
{
"$ref": "form-pagto-post.defs.json#/definitions/tipo_item_pagto"
}
],
"definitions": {
"tipo_item_pagto": {
"type": "object",
"additionalProperties": false,
"properties": {
"modulo": {
"type": "string",
"enum": [
"VENDAS",
"COMPRAS",
"GERAL",
"CHEQUES"
]
},
"descricao": {
"type": "string",
"maxLength": 100
},
"indicativo": {
"type": "string",
"enum": [
"A VISTA",
"A PRAZO"
]
},
"modalidade": {
"type": "string",
"enum": [
"DINHEIRO",
"CHEQUE",
"CARTAO DE CREDITO",
"CARTAO DE DEBITO",
"CRÉDITO LOJA",
"VALE REFEIÇÃO",
"BOLETO BANCÁRIO",
"SEM PAGAMENTO",
"REFINANCIAMENTO",
"OUTROS"
]
}
},
"required": [
"modulo",
"descricao",
"indicativo"
],
"description": "Forma de Pagamento"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 48,
"modulo": "GERAL",
"descricao": "teste1",
"indicativo": "A VISTA",
"modalidade": "CHEQUE",
"ativo": "SIM",
"CondicoesPagamento": []
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Criação Forma PagtoPOST/FormaPagamento
Processo de Criação de uma forma de pagamento.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| modulo | ✔️ | TipoModulo | Módulo do sistema que será usada a forma de pagamento. |
| descricao | ✔️ | String(100) | Informar a descrição da forma de pagamento. |
| indicativo | ✔️ | TipoIndicativo | Informar o indicativo de pagamento. |
| modalidade | TipoModalidade | Informar o Modalidade de pagamento. |
Tipos de dados usados:
Módulos para forma de pagamento
TipoModulo
-
VENDAS
-
COMPRAS
-
GERAL
-
CHEQUES
TipoModulo
-
VENDAS -
COMPRAS -
GERAL -
CHEQUES
Tipo Indicativo de pagamento
TipoIndicativo
-
A VISTA
-
A PRAZO
TipoIndicativo
-
A VISTA -
A PRAZO
Tipo Modalidade de pagamento
TipoModalidade
-
DINHEIRO
-
CHEQUE
-
CARTAO DE CREDITO
-
CARTAO DE DEBITO
-
CRÉDITO LOJA
-
VALE REFEIÇÃO
-
BOLETO BANCÁRIO
-
SEM PAGAMENTO
-
REFINANCIAMENTO
-
OUTROS
TipoModalidade
-
DINHEIRO -
CHEQUE -
CARTAO DE CREDITO -
CARTAO DE DEBITO -
CRÉDITO LOJA -
VALE REFEIÇÃO -
BOLETO BANCÁRIO -
SEM PAGAMENTO -
REFINANCIAMENTO -
OUTROS
GET https://open-api.eprom.com.br/api/FormaPagamento?id=123&modulo=GERAL&modalidade=CHEQUE&descricao=teste&indicativo=A VISTA&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 35,
"data": [
{
"id": 1,
"modulo": "VENDAS",
"descricao": "DINHEIRO",
"indicativo": "A VISTA",
"modalidade": "DINHEIRO",
"ativo": "SIM",
"CondicoesPagamento": [
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "CREDIARIO",
"indicativo": "A PRAZO",
"modalidade": "BOLETO BANCÁRIO",
"ativo": "NAO",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "CARTÃO DE CRÉDITO",
"indicativo": "A PRAZO",
"modalidade": "CARTAO DE CREDITO",
"ativo": "NAO",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 4,
"modulo": "VENDAS",
"descricao": "CARTÃO DE DÉBITO",
"indicativo": "A VISTA",
"modalidade": "CARTAO DE DEBITO",
"ativo": "NAO",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 5,
"modulo": "VENDAS",
"descricao": "CHEQUES DE TERCEIROS",
"indicativo": "A PRAZO",
"modalidade": "CHEQUE",
"ativo": "SIM",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 9,
"modulo": "GERAL",
"descricao": "COMPOSIÇÃO",
"indicativo": "A PRAZO",
"modalidade": "REFINANCIAMENTO",
"ativo": "SIM",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
},
{
"id": 12,
"modulo": "COMPRAS",
"descricao": "30/60 DDL",
"ativo": "NAO"
},
{
"id": 11,
"modulo": "COMPRAS",
"descricao": "30/45 DDL",
"ativo": "NAO"
},
{
"id": 10,
"modulo": "COMPRAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 6,
"modulo": "COMPRAS",
"descricao": "30/60",
"ativo": "SIM"
},
{
"id": 5,
"modulo": "COMPRAS",
"descricao": "30/45 DDL",
"ativo": "NAO"
},
{
"id": 4,
"modulo": "COMPRAS",
"descricao": "30",
"ativo": "SIM"
}
]
},
{
"id": 11,
"modulo": "GERAL",
"descricao": "DEVOLUÇÃO",
"indicativo": "A PRAZO",
"modalidade": "SEM PAGAMENTO",
"ativo": "SIM",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
},
{
"id": 12,
"modulo": "COMPRAS",
"descricao": "30/60 DDL",
"ativo": "NAO"
},
{
"id": 11,
"modulo": "COMPRAS",
"descricao": "30/45 DDL",
"ativo": "NAO"
},
{
"id": 10,
"modulo": "COMPRAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 6,
"modulo": "COMPRAS",
"descricao": "30/60",
"ativo": "SIM"
},
{
"id": 5,
"modulo": "COMPRAS",
"descricao": "30/45 DDL",
"ativo": "NAO"
},
{
"id": 4,
"modulo": "COMPRAS",
"descricao": "30",
"ativo": "SIM"
}
]
},
{
"id": 13,
"modulo": "VENDAS",
"descricao": "CREDITO EM CONTA",
"indicativo": "A VISTA",
"modalidade": "DINHEIRO",
"ativo": "NAO",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 14,
"modulo": "VENDAS",
"descricao": "NOTA DE CREDITO",
"indicativo": "A VISTA",
"modalidade": "CRÉDITO LOJA",
"ativo": "NAO",
"CondicoesPagamento": [
{
"id": 9,
"modulo": "VENDAS",
"descricao": "30 DDL",
"ativo": "NAO"
},
{
"id": 8,
"modulo": "VENDAS",
"descricao": "30/45/60 DDL",
"ativo": "NAO"
},
{
"id": 7,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "NAO"
},
{
"id": 3,
"modulo": "VENDAS",
"descricao": "30",
"ativo": "SIM"
},
{
"id": 2,
"modulo": "VENDAS",
"descricao": "30/45/60",
"ativo": "NAO"
},
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
},
{
"id": 15,
"modulo": "VENDAS",
"descricao": "PIX",
"indicativo": "A VISTA",
"modalidade": "DINHEIRO",
"ativo": "SIM",
"CondicoesPagamento": [
{
"id": 1,
"modulo": "VENDAS",
"descricao": "A VISTA",
"ativo": "SIM"
}
]
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Formas PagtosGET/FormaPagamento{?id,modulo,modalidade,descricao,indicativo,page,size}
Lista Formas de pagamento.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a forma de pagamento pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- modulo
string(optional) Example: GERALTipos de módulos. Se informado módulo, buscará as formas de pagamento pelo módulo. Poderá ser informado uma lista de valores separada por vírgula(,). As opções são:
VENDAS,COMPRAS,GERAL,CHEQUESChoices:
VENDASCOMPRASGERALCHEQUES- indicativo
string(optional) Example: A VISTATipos de Indicativo. Se informado o indicativo, buscará as formas de pagamento pelo indicativo de pagamento. Poderá ser informado uma lista de valores separada por vírgula(,). As opções são :
A VISTA,A PRAZOChoices:
A VISTAA PRAZO- descricao
string(optional) Example: testeSe informado, buscará por parte da descrição da forma de pagamento.
- modalidade
string(optional) Example: CHEQUETipos de modalidade. Se informada modalidade, buscará as formas de pagamento pela modalidade de pagamento. Poderá ser informado uma lista de valores separada por vírgula(,). As opções são :
DINHEIRO,CHEQUE,CARTAO DE CREDITO,CARTAO DE DEBITO,CRÉDITO LOJA,VALE REFEIÇÃO,BOLETO BANCÁRIO,SEM PAGAMENTO,REFINANCIAMENTO,OUTROSChoices:
DINHEIROCHEQUECARTAO DE CREDITOCARTAO DE DEBITOCRÉDITO LOJAVALE REFEIÇÃOBOLETO BANCÁRIOSEM PAGAMENTOREFINANCIAMENTOOUTROS- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
PUT https://open-api.eprom.com.br/api/FormaPagamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Body
{
"modulo": "GERAL",
"descricao": "Teste 1",
"indicativo": "A VISTA",
"modalidade": "CHEQUE"
}Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://eprom.com.br/schemas/form-pagto-put.defs.json",
"allOf": [
{
"$ref": "form-pagto-put.defs.json#/definitions/tipo_item_pagto"
}
],
"definitions": {
"tipo_item_pagto": {
"type": "object",
"additionalProperties": false,
"properties": {
"modulo": {
"type": "string",
"enum": [
"VENDAS",
"COMPRAS",
"GERAL",
"CHEQUES"
]
},
"descricao": {
"type": "string",
"maxLength": 100
},
"indicativo": {
"type": "string",
"enum": [
"A VISTA",
"A PRAZO"
]
},
"modalidade": {
"type": "string",
"enum": [
"DINHEIRO",
"CHEQUE",
"CARTAO DE CREDITO",
"CARTAO DE DEBITO",
"CRÉDITO LOJA",
"VALE REFEIÇÃO",
"BOLETO BANCÁRIO",
"SEM PAGAMENTO",
"REFINANCIAMENTO",
"OUTROS"
]
}
},
"required": [
"indicativo",
"descricao"
],
"description": "Forma de Pagamento"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"message": "Registro salvo",
"data": {
"id": 86,
"entidade_id": 25,
"tipo_vinculo_id": 4,
"entidade_id_vinc": 26
}
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Alteração Forma PagtoPUT/FormaPagamento/{id}
Processo de Alteração de uma forma de pagamento.
| Campo | Obrigatório | Tipo do Campo | Descritivo do Campo |
|---|---|---|---|
| modulo | TipoModulo | Módulo do sistema que será usada a forma de pagamento. | |
| descricao | ✔️ | String(100) | Informar a descrição da forma de pagamento. |
| indicativo | ✔️ | TipoIndicativo | Informar o indicativo de pagamento. |
| modalidade | TipoModalidade | Informar o Modalidade de pagamento. |
URI Parameters
- id
number(required) Example: 123Id da forma de pagamento a ser alterada.
DELETE https://open-api.eprom.com.br/api/FormaPagamento/123
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"message": "Forma de pagamento excluída"
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Exclusão de Forma pagtoDELETE/FormaPagamento/{id}
Processo de Exclusão de uma forma de pagamento.
URI Parameters
- id
number(required) Example: 123Id da forma de pagamento.
Tabelas Auxiliares ao Sistema ¶
Endpoint relativo à tabelas auxiliares no sistema.
GET https://open-api.eprom.com.br/api/Entidade/Atividade?id=123&codigo=codigo&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 1329,
"data": [
{
"id": 1,
"codigo": "0111-3/01",
"descricao": "Cultivo de arroz",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 2,
"codigo": "0111-3/02",
"descricao": "Cultivo de milho",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 3,
"codigo": "0111-3/03",
"descricao": "Cultivo de trigo",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 4,
"codigo": "0111-3/99",
"descricao": "Cultivo de outros cereais não especificados anteriormente",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 5,
"codigo": "0112-1/01",
"descricao": "Cultivo de algodão herbáceo",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 6,
"codigo": "0112-1/02",
"descricao": "Cultivo de juta",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 7,
"codigo": "0112-1/99",
"descricao": "Cultivo de outras fibras de lavoura temporária não especificadas anteriormente",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 8,
"codigo": "0113-0/00",
"descricao": "Cultivo de cana-de-açúcar",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 9,
"codigo": "0114-8/00",
"descricao": "Cultivo de fumo",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
},
{
"id": 10,
"codigo": "0115-6/00",
"descricao": "Cultivo de soja",
"ClasseCnae": {
"id": 1,
"codigo": "01.11-3",
"descricao": "Produção de lavouras temporárias",
"GrupoCnae": {
"id": 1,
"codigo": "01.1",
"descricao": "Produção de lavouras temporárias",
"DivisaoCnae": {
"id": 1,
"codigo": "01",
"descricao": "AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS",
"SecaoCnae": {
"id": 1,
"codigo": "A",
"descricao": "AGRICULTURA, PECUÁRIA, PRODUÇÃO FLORESTAL, PESCA E AQÜICULTURA"
}
}
}
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar AtividadesGET/Entidade/Atividade{?id,codigo,descricao,page,size}
Lista as Atividades Comerciais.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a ativdade comercial pelo id.
- codigo
string(optional) Example: codigoSe informado, buscará por parte do código.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Cidade?id=123&uf=SP&localidade=cidade&codigo_ibge=3512345&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 5654,
"data": [
{
"id": 1,
"localidade": "COITE DO NOIA",
"codigo_ibge": 2702009,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 2,
"localidade": "COLONIA LEOPOLDINA",
"codigo_ibge": 2702108,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 3,
"localidade": "COQUEIRO SECO",
"codigo_ibge": 2702207,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 4,
"localidade": "CORURIPE",
"codigo_ibge": 2702306,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 5,
"localidade": "CRAIBAS",
"codigo_ibge": 2702355,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 6,
"localidade": "DELMIRO GOUVEIA",
"codigo_ibge": 2702405,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 7,
"localidade": "DOIS RIACHOS",
"codigo_ibge": 2702504,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 8,
"localidade": "ESTRELA DE ALAGOAS",
"codigo_ibge": 2702553,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 9,
"localidade": "FEIRA GRANDE",
"codigo_ibge": 2702603,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
},
{
"id": 10,
"localidade": "FELIZ DESERTO",
"codigo_ibge": 2702702,
"Uf": {
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar CidadesGET/Cidade{?id,uf,localidade,codigo_ibge,page,size}
Lista as cidades do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a cidade pelo id.
- uf
string(optional) Example: SPSe informado, buscará cidade pela uf.
- localidade
string(optional) Example: cidadeSe informado, buscará por parte da localidade.
- codigo_ibge
number(optional) Example: 3512345Se informado, buscará pelo código do ibge.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Conta?id=123&conta=abc&descricao=abc&agencia=abc&tipo=abc&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 37,
"data": [
{
"id": 100,
"conta": "Baixas Cartões",
"descricao": "Baixas Cartões",
"agencia": null,
"tipo": "CORRENTE",
"Banco": null,
"Filial": {
"id": 83,
"nome": "ONONONONONONO"
}
},
{
"id": 101,
"conta": "Baixas Mkp",
"descricao": "Baixas Mkp",
"agencia": null,
"tipo": "CORRENTE",
"Banco": null,
"Filial": {
"id": 83,
"nome": "ONONONONONONO"
}
},
{
"id": 102,
"conta": "Baixas Antigas",
"descricao": "Baixas Antigas",
"agencia": null,
"tipo": "CORRENTE",
"Banco": null,
"Filial": {
"id": 83,
"nome": "ONONONONONONO"
}
},
{
"id": 179,
"conta": "123-4",
"descricao": "BANCO BRADESCO",
"agencia": "9999",
"tipo": "CORRENTE",
"Banco": {
"id": 19,
"nome": "BANCO BRADESCO S.A."
},
"Filial": {
"id": 83,
"nome": "ONONONONONONO"
}
},
{
"id": 180,
"conta": "456-6",
"descricao": "BANCO ITAU",
"agencia": "1657",
"tipo": "CORRENTE",
"Banco": {
"id": 9337,
"nome": "ITAU UNIBANCO S.A."
},
"Filial": {
"id": 83,
"nome": "ONONONONONONO"
}
},
{
"id": 181,
"conta": "1047414250",
"descricao": "MAQUINA CIELO",
"agencia": "",
"tipo": "CORRENTE",
"Banco": {
"id": 19,
"nome": "BANCO BRADESCO S.A."
},
"Filial": {
"id": 83,
"nome": "ONONONONONONO"
}
},
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar ContasGET/Conta{?id,conta,descricao,agencia,tipo,page,size}
Lista as contas para baixa bancárias do sistema.
URI Parameters
- id
number(optional) Example: 123Buscará a conta pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- conta
string(optional) Example: abcSe informado, buscará a conta ou parte do conteúdo escrito no campo conta.
- descricao
string(optional) Example: abcSe informado, buscará a descricao ou parte do conteúdo escrito na descrição conta.
- agencia
string(optional) Example: abcSe informado, buscará a agência ou parte do conteúdo escrito na agência.
- tipo
string(optional) Example: abcSe informado, buscará o tipo ou parte do conteúdo escrito no tipo.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Pais?id=123&nome=BRASIL&codigo=1012&sigla=BRL&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 6,
"data": [
{
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
},
{
"id": 2,
"nome": "PORTUGAL",
"codigo": 6076,
"sigla": "PT"
},
{
"id": 3,
"nome": "CHILE",
"codigo": 1589,
"sigla": "CH"
},
{
"id": 4,
"nome": "ALEMANHA",
"codigo": 230,
"sigla": "DE"
},
{
"id": 5,
"nome": "REPÚBLICA TCHECA",
"codigo": 7919,
"sigla": "CZ"
},
{
"id": 6,
"nome": "ESTADOS UNIDOS",
"codigo": 2496,
"sigla": "EUA"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar PaísesGET/Pais{?id,nome,codigo,sigla,page,size}
Lista os Países do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o país pelo id.
- nome
string(optional) Example: BRASILSe informado, buscará o país por parte da descrição.
- codigo
string(optional) Example: 1012Se informado, buscará o país pelo código BACEN.
- sigla
string(optional) Example: BRLSe informado, buscará o país pela sigla.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/TipoContato?id=123&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 8,
"data": [
{
"id": 1,
"descricao": "TELEFONE FIXO PRINCIPAL"
},
{
"id": 2,
"descricao": "TELEFONE MOVEL PRINCIPAL"
},
{
"id": 3,
"descricao": "EMAIL (NF-e)"
},
{
"id": 4,
"descricao": "TELEFONE COMERCIAL"
},
{
"id": 5,
"descricao": "TELEFONE FIXO OPCIONAL"
},
{
"id": 6,
"descricao": "HOME PAGE"
},
{
"id": 7,
"descricao": "EMAIL"
},
{
"id": 8,
"descricao": "WhatsApp"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Tipos de ContatoGET/TipoContato{?id,descricao,page,size}
Lista os tipos de contato do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o tipo do contato pelo id.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/TipoDocumento?id=123&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 11,
"data": [
{
"id": 1,
"descricao": "CNPJ"
},
{
"id": 2,
"descricao": "CPF"
},
{
"id": 3,
"descricao": "IE"
},
{
"id": 4,
"descricao": "RG"
},
{
"id": 5,
"descricao": "CTPS"
},
{
"id": 6,
"descricao": "Carteira Nacional Habilitacao (CNH)"
},
{
"id": 7,
"descricao": "Documento Nacional Identidade (DNI)"
},
{
"id": 8,
"descricao": "Registro Nacional de Estrangeiro (RNE)"
},
{
"id": 9,
"descricao": "Registro Orgão de Classe (OC)"
},
{
"id": 10,
"descricao": "Suframa"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Tipos de DocumentoGET/TipoDocumento{?id,descricao,page,size}
Lista os tipos de contato do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o tipo do contato pelo id.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/TipoEndereco?id=123&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 5,
"data": [
{
"id": 1,
"descricao": "PRINCIPAL"
},
{
"id": 2,
"descricao": "COMERCIAL"
},
{
"id": 3,
"descricao": "COBRANÇA"
},
{
"id": 4,
"descricao": "CORRESPONDENCIA"
},
{
"id": 5,
"descricao": "ENTREGA"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Tipos de EndereçoGET/TipoEndereco{?id,descricao,page,size}
Lista os tipos de endereço do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o tipo do contato pelo id.
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/TipoVinculo?id=123&codigo=descricao&descricao=descricao&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 27,
"data": [
{
"id": 1,
"codigo": 1,
"descricao": "CONJUGE"
},
{
"id": 2,
"codigo": 3,
"descricao": "FILHO(A) OU ENTEADO(A)"
},
{
"id": 3,
"codigo": null,
"descricao": "AVALISTA"
},
{
"id": 4,
"codigo": null,
"descricao": "VENDEDOR"
},
{
"id": 5,
"codigo": null,
"descricao": "COMPRADOR"
},
{
"id": 6,
"codigo": 9,
"descricao": "PAI"
},
{
"id": 7,
"codigo": 9,
"descricao": "MAE"
},
{
"id": 8,
"codigo": null,
"descricao": "SINDICATO"
},
{
"id": 9,
"codigo": 2,
"descricao": "COMPANHEIRO(A) COM O(A) QUAL TENHA FILHO OU VIVA HÁ MAIS DE 5 (CINCO) ANOS OU POSSUA DECLARAÇÃO DE UNIÃO ESTÁVEL"
},
{
"id": 10,
"codigo": 4,
"descricao": "FILHO(A) OU ENTEADO(A), UNIVERSITÁRIO(A) OU CURSANDO ESCOLA TÉCNICA DE 2º GRAU"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar Tipos de VínculosGET/TipoVinculo{?id,codigo,descricao,page,size}
Lista os tipos de endereço do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará o tipo do vínculo pelo id. Poderá ser informado uma lista de valores separada por vírgula(,).
- codigo
string(optional) Example: descricaoSe informado, buscará o tipo do vínculo pelo código. Poderá ser informado uma lista de valores separada por vírgula(,).
- descricao
string(optional) Example: descricaoSe informado, buscará por parte da descrição.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
GET https://open-api.eprom.com.br/api/Uf?id=123&uf=SP&estado=cidade&page=1&size=10
Requests
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>Responses
Headers
Content-Type: application/jsonBody
{
"page": 0,
"size": 10,
"count": 34,
"data": [
{
"id": 1,
"sigla": "AC",
"estado": "Acre",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 2,
"sigla": "AL",
"estado": "Alagoas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 3,
"sigla": "AM",
"estado": "Amazonas",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 4,
"sigla": "AP",
"estado": "Amapa",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 5,
"sigla": "BA",
"estado": "Bahia",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 6,
"sigla": "CE",
"estado": "Ceará",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 7,
"sigla": "DF",
"estado": "Distrito federal",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 8,
"sigla": "ES",
"estado": "Espirito Santo",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 9,
"sigla": "GO",
"estado": "Goiás",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
},
{
"id": 10,
"sigla": "MA",
"estado": "Maranhao",
"Pais": {
"id": 1,
"nome": "BRASIL",
"codigo": 1058,
"sigla": "BR"
}
}
]
}Headers
Content-Type: application/jsonBody
{
"code": 400,
"error": "ValidationErrors",
"message": "Bad Request"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erros de Validação"
},
"message": {
"type": "string",
"description": "Mensagem do erro"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 404,
"error": "ItemNotFound",
"message": "Item não encontrado"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Item Inexistente"
},
"message": {
"type": "string",
"description": "Item não encontrado"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 500,
"error": "ErrorInternal",
"message": "Fail to Authentication"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Headers
Content-Type: application/jsonBody
{
"code": 503,
"error": "InternalError",
"message": "Ocorreu um erro"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Código Erro"
},
"error": {
"type": "string",
"description": "Erro interno"
},
"message": {
"type": "string",
"description": "Erro no servidor"
}
}
}Listar UfsGET/Uf{?id,uf,estado,page,size}
Lista as UFs do sistema.
URI Parameters
- id
number(optional) Example: 123Se informado id, buscará a uf pelo id.
- uf
string(optional) Example: SPSe informado, buscará uf pela pela sigla.
- estado
string(optional) Example: cidadeSe informado, buscará por parte do estado.
- page
number(optional) Default: 0 Example: 1Informar a página quando houver mais de uma página.
- size
number(optional) Default: 10 Example: 10Informar a quantidade de registros por página. Default é 10.
Generated by aglio on 25 Apr 2025