API docs by Redocly

ReneoTec | Documentação (0.2.0)

Download OpenAPI specification:Download

E-mail: suporte@reneoTec.com.br URL: https://www.gruponsc.com.br/

Introdução

Documentação dos recursos de público acesso da API ReneoTec, responsável pela emissão de notas fiscais

Login

Exemplos de operações com recursos de logins

Criar novo login

Responsável por criar um novo login

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de um login.

email
required
string

Email para autenticação.

name
required
string

Nome de identificação.

password
required
string >= 6 characters

Senha de acesso.

phonenumber
required
string

Número de celular no formato +55#########.

Responses

Request samples

Content type
application/json
{
  • "name": "José da Silva",
  • "password": "123456",
  • "email": "josedasilva@email.com",
  • "phonenumber": "+5519977771111",
  • "role": "user"
}

Response samples

Content type
application/json
{
  • "id": "3151969e-6f36-4398-aae0-266b3de4349d",
  • "email": "josedasilva@email.com",
  • "name": "José da Silva",
  • "phonenumber": "+551992222222",
  • "role": "user",
  • "owner": {
    },
  • "plan": {
    },
  • "dateRegister": "2024-05-14"
}

Alteração de login

Responsável por alterar elementos do login

path Parameters
id
required
string

Identificador único (UUID) do usuario.

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de um login.

email
string <email>

Email para autenticação.

name
string

Nome de identificação.

password
string >= 6 characters

Senha de acesso.

phonenumber
string

Número de celular no formato +55#########.

Responses

Request samples

Content type
application/json
{
  • "email": "josedasilva@email.com",
  • "name": "José da Silva",
  • "password": "123456",
  • "phonenumber": "+5519977771111",
  • "blocked": false
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "email": "josedasilva@email.com",
  • "name": "José da Silva",
  • "phonenumber": "+5519977771111"
}

Logout

Responsável por revogar token de acesso, obrigando a re-autentificação do usuario para geração de novo token.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "Não foi encontrado nenhum token para ser revogado, verifique as informações e tente novamente."
}

Autenticação

Responsável por gerar um access token e um refresh token.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para autenticar.

email
required
string

Email para autenticação.

password
required
string >= 6 characters

Senha de acesso.

Responses

Request samples

Content type
application/json
{
  • "email": "josedasilva@email.com",
  • "password": "123456"
}

Response samples

Content type
application/json
{
  • "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbklEIjoiYzkzYmUyODktMWQ0Yi00ZjBiLWE5YWEtMmEwODUyNDlmYWJlIiwicm9sZSI6ImFkbWluIiwiZW1pdHRlcklEIjoiMmI2YWFkYzItMWI5ZC00OWY4LWIxOWEtMmE5ZjExYWEzMDUwIiwiZW1pdHRlclBsYW4iOiJiYXNpYyIsIm93bmVySUQiOiJjOTNiZTI4OS0xZDRiLTRmMGItYTlhYS0yYTA4NTI0OWZhYmUiLCJpYXQiOjE3MTU3MTExOTIsImV4cCI6MTcxNTcxMjk5Mn0.47NZwzGyYjJPpud2lR4cvTYOaYwjuocf_O45y3a5jyk",
  • "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbklEIjoiYzkzYmUyODktMWQ0Yi00ZjBiLWE5YWEtMmEwODUyNDlmYWJlIiwicm9sZSI6ImFkbWluIiwiZW1pdHRlcklEIjoiMmI2YWFkYzItMWI5ZC00OWY4LWIxOWEtMmE5ZjExYWEzMDUwIiwiZW1pdHRlclBsYW4iOiJiYXNpYyIsIm93bmVySUQiOiJjOTNiZTI4OS0xZDRiLTRmMGItYTlhYS0yYTA4NTI0OWZhYmUiLCJpYXQiOjE3MTU3MTExOTIsImV4cCI6MTcxNjMxNTk5Mn0.NuWhMXW7i6MHksIoBv9VlaWfh679LHS1K2Q_CAMB5Qk",
  • "id": "c93be289-1d4b-4f0b-a9aa-2a085249fabe",
  • "ownerID": "c93be289-1d4b-4f0b-a9aa-2a085249fabe",
  • "expiredPLan": "2024-06-14T19:44:44.356Z",
  • "plan": "basic"
}

Renovação de refresh token

Responsável por rotacionar o refresh token, permitindo a geração de um novo access token.

header Parameters
Authorization
required
string <jwt>

refresh token - Token de atualização.

Responses

Response samples

Content type
application/json
{
  • "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbklEIjoiMjJkMjViZTItNmU3OC00MGZhLTgwYTktOTU5MDZlMmFmZDEzIiwiaWF0IjoxNjg0MzM2MTc5LCJleHAiOjE2ODQzMzc5Nzl9.f7cUy5eFsrtyVo4HiAQq-oQtJo6iA09W4Es5TVElPkM",
  • "plan": "basic"
}

Criação de token para resetar senha

Responsável por gerar um token unico referente ao processo de reset da senha, permitindo a geração de uma nova senha ao utiliza-lo.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para gerar token de alteração de senha.

email
required
string <email>

Email para autenticação.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Alteração de senha utilizando token

Responsável por gerar um token único referente ao processo de reset da senha, permitindo a geração de uma nova senha ao utiliza-lo.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para gerar token de alteração de senha.

password
required
string <password>

nova senha.

token
required
string <uuid>

token único para controle de alteração de senha.

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word",
  • "token": "b5507016-7da2-4777-a161-1e8042a6a377"
}

Response samples

Content type
application/problem+json
{
  • "message": "Mensagem com autenticação não permitida na solicitação"
}

Emitter

Exemplos de operações com recursos de emitente

Listar emitente

Responsável por listar emitter

query Parameters
businessName
string

filtro pelo Nome Empresarial.

document
string

filtro pelo CPF/CNPJ.

name
string

filtro pelo Nome Fantasia.

id
string

filtro pelo codigo de identificação do 'emitter'.

loginID
string

filtro pelo codigo de identificação do 'login'.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de emitente

Responsável por adicionar um novo emitter na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo emitente.

document
required
string

CPF/CNPJ.

contributorType
required
enum['contribuinte-icms', 'contribuinte-isento']

Indicador de inscrição estadual.

stateRegistration
required
string

Inscrição Estadual.

taxRegime
required
string

Regime tributário.

taxPersonType
required
enum['Jurídica', 'Física']

Tipo Pessoa.

businessName
required
string

Nome empresarial.

name
required
string

Nome fantasia.

required
object

Endereço.

required
object

Aliquota de ICMS do mês.

isTaxSubstitute
required
boolean

É substituto de ICMS.

hasTaxBenefit
required
boolean

Tem benefícios.

plan
required
string

Plano do sistema.

required
object

Informações das NFes.

Responses

Request samples

Content type
application/json
{
  • "document": "36241947000131",
  • "contributorType": "contribuinte-isento",
  • "stateRegistration": "ISENTO",
  • "taxRegime": "simples-nacional",
  • "name": "nome",
  • "businessName": "Nome",
  • "address": {
    },
  • "monthICMS": {
    },
  • "isTaxSubstitute": true,
  • "hasTaxBenefit": false,
  • "series": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ef78832a-a626-4eb2-b8ee-c73220608385",
  • "document": "36241947000131",
  • "contributorType": "contribuinte-isento",
  • "stateRegistration": "ISENTO",
  • "taxRegime": "simples-nacional",
  • "name": "nome",
  • "businessName": "Nome",
  • "address": {
    },
  • "logins": [
    ],
  • "monthICMS": {
    },
  • "isTaxSubstitute": true,
  • "hasTaxBenefit": false,
  • "series": [
    ]
}

Alteração de emitente

Responsável por alterar informações de emitter na base.

path Parameters
id
required
string

Identificador único (UUID) da transportadora.

header Parameters
Authorization
required
string

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo emitente.

document
string

CPF/CNPJ.

contributorType
enum['contribuinte-icms', 'contribuinte-isento']

Indicador de inscrição estadual.

stateRegistration
string

Inscrição Estadual.

taxRegime
string

Regime tributário.

taxPersonType
enum['Jurídica', 'Física']

Tipo pessoa.

businessName
string

Nome empresarial.

name
string

Nome fantasia.

object

Endereço.

Array of objects

Informações de acesso do emitente.

Responses

Request samples

Content type
application/json
{
  • "document": "61302231022",
  • "contributorType": "contribuinte-icms",
  • "stateRegistration": "588793479412",
  • "taxRegime": "simples-nacional",
  • "name": "Reneo Tec.",
  • "businessName": "Reneo Tec.",
  • "address": {
    },
  • "logins": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "document": "61302231022",
  • "contributorType": "contribuinte-icms",
  • "stateRegistration": "588793479412",
  • "taxRegime": "simples-nacional",
  • "taxPersonType": "Jurídica",
  • "name": "Reneo Tec.",
  • "businessName": "Reneo Tec.",
  • "address": {
    },
  • "logins": [
    ]
}

Exclusão de emitente

Responsável por remover emitter da base.

path Parameters
id
required
string

Identificador único (UUID) da transportadora.

header Parameters
Authorization
required
string

token - Token de autenticação.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Person

Exemplos de operações com recursos de transportadora, clientes e fornecedores

Listar clientes

Endpoint para listagem de todos os clientes

query Parameters
name
string

filtro pelo nome.

code
number

filtro pelo code.

document
string

filtro pelo CPF/CNPJ.

email
string

filtro pelo email.

phonenumber
string

filtro pelo telefone.

id
string <uuid>

filtro pelo codigo de identificação do 'client'.

emitterID
string

filtro pelo codigo de identificação do emitente.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token de autorização.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de cliente

Responsável por adicionar um novo client na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de um cliente.

email
required
string

Email.

name
required
string

Nome de identificação.

companyName
required
string

Razão Social.

emitterID
required
string

Identificador do emitente.

document
required
string

CPF/CNPJ.

stateRegistration
required
string

Inscrição Estadual.

foreignID
string

Identificação do destinatário estrangeiro.

taxRegime
required
string

Regime tributário.

taxPersonType
enum['Jurídica', 'Física']

Tipo Pessoa.

contributorType
required
string

Indicador de inscrição estadual.

phonenumber
required
string

Número de celular no formato +55#########.

required
object

Endereço.

object

Endereço de entrega.

object

Endereço de cobrança.

Responses

Request samples

Content type
application/json
{
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "companyName": "José da Silva",
  • "document": "61302231022",
  • "phonenumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "taxPersonType": "Jurídica",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "address": {
    },
  • "deliveryAddress": {
    },
  • "billingAddress": { }
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "companyName": "José da Silva",
  • "code": 12,
  • "document": "61302231022",
  • "phoneNumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "taxPersonType": "Jurídica",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "personType": [
    ],
  • "address": {
    },
  • "deliveryAddress": { }
}

Alteração de cliente

Responsável por alterar elementos do cliente.

path Parameters
id
required
string

Identificador único (UUID) do cliente.

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de um cliente.

email
string

Email.

name
string

Nome de identificação.

emitterID
string

Identificador do emitente.

document
string

CPF/CNPJ.

stateRegistration
string

Inscrição Estadual.

foreignID
string

Identificação do destinatário estrangeiro.

taxRegime
string

Regime tributário.

contributorType
string

Indicador de inscrição estadual.

phonenumber
string

Número de celular no formato +55#########.

personType
Array of arrays

Tipo de pessoa.

object

Endereço.

object

Endereço de entrega.

object

Endereço de cobrança.

Responses

Request samples

Content type
application/json
{
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "phonenumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "personType": [
    ],
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "phonenumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "personType": [
    ],
  • "address": {
    }
}

Excluir cliente

Responsável por excluir registro do cliente.

path Parameters
id
required
string

Identificador único (UUID) do usuario.

header Parameters
Authorization
required
string

token de autorização.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Listar transportadoras

Endpoint para listagem de todas as transportadoras

query Parameters
name
string

filtro pelo nome.

document
string

filtro pelo CPF/CNPJ.

id
string <uuid>

filtro pelo codigo de identificação da 'transporter'.

emitterID
string

filtro pelo codigo de identificação do emitente.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token de autorização.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de transportadora

Responsável por adicionar um novo Transporter na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de uma transportadora.

name
required
string

Nome de identificação.

phonenumber
required
string

Número de celular no formato +55#########.

email
required
string

Email.

emitterID
required
string

Identificador do emitente.

document
required
string

CPF/CNPJ.

stateRegistration
required
string

Inscrição Estadual.

contributorType
required
string

Indicador de inscrição estadual.

required
object

Endereço.

Responses

Request samples

Content type
application/json
{
  • "stateRegistration": "588793479412",
  • "contributorType": "contribuinte-icms",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "email": "jose.silva@email.com",
  • "phonenumber": "+5519977771111",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "stateRegistration": "588793479412",
  • "contributorType": "contribuinte-icms",
  • "name": "José da Silva",
  • "email": "josedasilva@email.com",
  • "document": "61302231022",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "phonenumber": "+5519977771111",
  • "personType": [
    ],
  • "address": {
    }
}

Alteração de transportadora

Responsável por alterar elementos da transportadora.

path Parameters
id
required
string

Identificador único (UUID) da transportadora.

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de uma transportadora.

name
string

Nome de identificação.

document
string

CPF/CNPJ.

stateRegistration
string

Inscrição Estadual.

object

Endereço.

Responses

Request samples

Content type
application/json
{
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "address": {
    }
}

Excluir transportadora

Responsável por excluir registro da transportadora.

path Parameters
id
required
string

Identificador único (UUID) do usuario.

header Parameters
Authorization
required
string

token de autorização.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Listar fornecedores

Endpoint para listagem de todos os fornecedores

query Parameters
name
string

filtro pelo nome.

document
string

filtro pelo CPF/CNPJ.

email
string

filtro pelo email.

phonenumber
string

filtro pelo telefone.

id
string <uuid>

filtro pelo codigo de identificação do 'transporter'.

emitterID
string

filtro pelo codigo de identificação do emitente.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token de autorização.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de fornecedor

Responsável por adicionar um novo supplier na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de um fornecedor.

email
required
string

Email.

name
required
string

Nome de identificação.

emitterID
required
string

Identificador do emitente.

document
required
string

CPF/CNPJ.

stateRegistration
required
string

Inscrição Estadual.

foreignID
string

Identificação do destinatário estrangeiro.

taxRegime
required
string

Regime tributário.

taxPersonType
enum['Jurídica', 'Física']

Tipo Pessoa.

contributorType
required
string

Indicador de inscrição estadual.

phonenumber
required
string

Número de celular no formato +55#########.

required
object

Endereço.

object

Endereço de entrega.

object

Endereço de cobrança.

Responses

Request samples

Content type
application/json
{
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "phonenumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "taxPersonType": "Jurídica",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "address": {
    },
  • "deliveryAddress": {
    },
  • "billingAddress": { }
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "phoneNumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "taxPersonType": "Jurídica",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "personType": [
    ],
  • "address": {
    },
  • "deliveryAddress": { }
}

Alteração de fornecedor

Responsável por alterar elementos do fornecedor.

path Parameters
id
required
string

Identificador único (UUID) do fornecedor.

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de um fornecedor.

email
string

Email.

name
string

Nome de identificação.

emitterID
string

Identificador do emitente.

document
string

CPF/CNPJ.

stateRegistration
string

Inscrição Estadual.

foreignID
string

Identificação do destinatário estrangeiro.

taxRegime
string

Regime tributário.

contributorType
string

Indicador de inscrição estadual.

phonenumber
string

Número de celular no formato +55#########.

personType
Array of arrays

Tipo de pessoa.

object

Endereço.

object

Endereço de entrega.

object

Endereço de cobrança.

Responses

Request samples

Content type
application/json
{
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "phonenumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "personType": [
    ],
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "email": "josedasilva@email.com",
  • "stateRegistration": "588793479412",
  • "name": "José da Silva",
  • "document": "61302231022",
  • "phonenumber": "+5519977771111",
  • "taxRegime": "simples-nacional",
  • "contributorType": "nao-contribuinte",
  • "emitterID": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "personType": [
    ],
  • "address": {
    }
}

Excluir fornecedor

Responsável por excluir registro do fornecedor.

path Parameters
id
required
string

Identificador único (UUID) do usuario.

header Parameters
Authorization
required
string

token de autorização.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Product

Exemplos de operações com recursos de produto

Listar produtos

Endpoint para listagem de todos os produtos

query Parameters
id
string

filtro pelo id.

name
string

filtro pelo name.

code
string

filtro pelo code.

barCode
string

filtro pelo barCode.

customCode
string

filtro pelo customCode.

emitterID
string

filtro pelo ID do emitente.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token de autorização.

Responses

Response samples

Content type
application/json
{
  • "summary": [
    ],
  • "data": [
    ]
}

Cadastro de produto

Responsável por adicionar um novo produto na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de um produto.

name
required
string

Nome de identificação.

type
required
string

Tipo de produto.

unityType
required
string

Tipo de unidade.

price
required
number

Preço.

cest
required
string

Código CEST.

ncm
required
string

Código NCM.

code
required
string

Código interno.

barCode
required
string

Código GTIN.

customCode
required
string

Código customCode.

object

Taxas e Impostos

emitterID
required
string

Identificador do emitente.

Responses

Request samples

Content type
application/json
{
  • "name": "Incredible Steel Bacon",
  • "type": "service",
  • "unityType": "UN",
  • "price": 3,
  • "cest": "642897",
  • "ncm": "96140000",
  • "code": "1",
  • "barCode": "7891000100103",
  • "customCode": "AXw102",
  • "tax": {
    },
  • "emitterID": "8b861c61-6414-478b-ad1f-b0dd2b4169fd"
}

Response samples

Content type
application/json
{
  • "id": "d3540529-4e06-4f75-a536-087072ab0509",
  • "name": "Incredible Steel Bacon",
  • "type": "service",
  • "unityType": "UN",
  • "price": 3,
  • "cest": "642897",
  • "ncm": "96140000",
  • "code": "1",
  • "barCode": "7891000100103",
  • "customCode": "AXw102",
  • "tax": {
    },
  • "emitterID": "8b861c61-6414-478b-ad1f-b0dd2b4169fd"
}

Alteração de produto

Responsável por alterar elementos do produto.

path Parameters
id
required
string

Identificador único (UUID) do produto.

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de um produto.

name
string

Nome de identificação.

type
string

Tipo de produto.

unityType
string

Tipo de unidade.

price
number

Preço.

cest
string

Código CEST.

ncm
string

Código NCM.

code
string

Código interno.

barCode
string

Código GTIN.

customCode
string

Código customCode.

object

Taxa e Impostos

Responses

Request samples

Content type
application/json
{
  • "name": "Incredible Steel Bacon",
  • "type": "service",
  • "unityType": "UN",
  • "price": 3,
  • "cest": "642897",
  • "ncm": "96140000",
  • "code": "1",
  • "barCode": "7891000100103",
  • "customCode": "AXw102",
  • "tax": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d3540529-4e06-4f75-a536-087072ab0509",
  • "name": "Incredible Steel Bacon",
  • "type": "service",
  • "unityType": "UN",
  • "price": 3,
  • "cest": "642897",
  • "ncm": "96140000",
  • "code": "1",
  • "barCode": "7891000100103",
  • "customCode": "AXw102",
  • "tax": {
    },
  • "emitterID": "8b861c61-6414-478b-ad1f-b0dd2b4169fd"
}

Excluir produto

Responsável por excluir registro do produto.

path Parameters
id
required
string

Identificador único (UUID) do produto.

header Parameters
Authorization
required
string

token de autorização.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Invoice

Exemplos de operações com recursos de documentos fiscais

Listar documento fiscal

Responsável por listar invoice

query Parameters
id
string

filtro pelo ID de identificação do 'invoice'.

emitterID
string

filtro pelo ID do emitente de identificação do 'invoice'.

code
number

filtro pelo codigo de identificação do 'invoice'.

clientID
number

filtro pelo ID do cliente de identificação do 'invoice'.

status
string

filtro pelo status do documento fiscal de identificação do 'invoice'.

object

filtro pelo operation na data do documento fiscal do 'invoice'.

object

define a ordenação dos registros

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de documento fiscal

Responsável por adicionar um novo invoice na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo documento fiscal.

required
object

Emitter.

required
object

client.

billingDate
required
string

billingDate.

required
object

operation.

required
Array of objects

products.

required
object

payment.

required
object

Emitter.

required
Array of objects

authorized.

required
object

totals.

observations
required
string

observations.

status
required
enum['draft', 'queue', 'approved', 'canceled', 'unused', 'rejected ']

status.

Responses

Request samples

Content type
application/json
{
  • "emitter": {
    },
  • "client": {
    },
  • "billingDate": "2023-11-30",
  • "operation": {
    },
  • "products": [
    ],
  • "payment": {
    },
  • "freight": {
    },
  • "authorized": [
    ],
  • "totals": {
    },
  • "observations": "Obs 1.0 ver qual eh",
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "id": "8cb5adf2-b683-4386-84ff-8d18928dd61b",
  • "emitter": {
    },
  • "client": {
    },
  • "billingDate": "2023-11-30",
  • "operation": {
    },
  • "products": [
    ],
  • "payment": {
    },
  • "freight": {
    },
  • "authorized": [
    ],
  • "totals": {
    },
  • "observations": "Obs 1.0 ver qual eh",
  • "status": "draft"
}

Alteração de Invoice

Responsável por alterar informações de invoice na base.

path Parameters
id
required
string

Identificador único (UUID) do invoice.

header Parameters
Authorization
required
string

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alterar um Invoice.

object

Emitter.

object

client.

billingDate
string

billingDate.

object

operation.

Array of objects

products.

object

payment.

object

Emitter.

Array of objects

authorized.

object

totals.

observations
string

observations.

status
enum['draft', 'queue', 'approved', 'canceled', 'unused', 'rejected']

status.

Responses

Request samples

Content type
application/json
{
  • "emitter": {
    },
  • "client": {
    },
  • "billingDate": "2023-11-30",
  • "operation": {
    },
  • "products": [
    ],
  • "payment": {
    },
  • "freight": {
    },
  • "authorized": [
    ],
  • "totals": {
    },
  • "observations": "Obs 1.0 ver qual eh",
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "id": "8cb5adf2-b683-4386-84ff-8d18928dd61b",
  • "emitter": {
    },
  • "client": {
    },
  • "billingDate": "2023-11-30",
  • "operation": {
    },
  • "products": [
    ],
  • "payment": {
    },
  • "freight": {
    },
  • "authorized": [
    ],
  • "totals": {
    },
  • "observations": "Obs 1.0 ver qual eh",
  • "status": "draft"
}

Exclusão de Invoice

Responsável por remover invoice da base.

path Parameters
id
required
string

Identificador único (UUID) do invoice.

header Parameters
Authorization
required
string

token - Token de autenticação.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Envio de E-mail dos Invoices

Responsável por compartilhar os invoices approved.

header Parameters
Authorization
required
string

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados para envio do e-mail.

id
string

id.

object

Destinatário do e-mail.

object

Informações do Remetente .

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "invalid refresh token data"
}

Listar documento fiscal Agregado

Responsável por listar invoice agregado

query Parameters
id
string

filtro pelo ID de identificação do 'invoice'.

emitterID
string

filtro pelo ID do emitente de identificação do 'invoice'.

code
number

filtro pelo codigo de identificação do 'invoice'.

clientID
number

filtro pelo ID do cliente de identificação do 'invoice'.

status
string

filtro pelo status do documento fiscal de identificação do 'invoice'.

object

filtro pelo operation na data do documento fiscal do 'invoice'.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Content type
application/json
{
  • "byYear": {
    },
  • "byMonthYear": {
    },
  • "byWeek": {
    },
  • "byDayMonthYear": {
    }
}

Atualização de status de Invoice

Responsável por alterar informações de invoice na base.

path Parameters
id
required
string

Identificador único (UUID) do invoice.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para atualizar o status de um Invoice.

object

Status da nota a ser atualizada.

access_key
string

chave de acesso.

receipt
string

número do recibo.

Responses

Request samples

Content type
application/json
{
  • "status": {
    },
  • "access_key": "3524040836263300015155001000000010213961520",
  • "receipt": "570096604241981"
}

Response samples

Content type
application/json
{
  • "id": "8cb5adf2-b683-4386-84ff-8d18928dd61b",
  • "emitter": {
    },
  • "client": {
    },
  • "billingDate": "2023-11-30",
  • "operation": {
    },
  • "products": {
    },
  • "payment": {
    },
  • "freight": {
    },
  • "authorized": {
    },
  • "totals": {
    },
  • "observations": "Obs 1.0 ver qual eh",
  • "status": "approved",
  • "rejection": null,
  • "history": [
    ],
  • "accessKey": "3524046530917200019755001000000005323574860",
  • "receipt": "573689879371021"
}

Gerar urls credenciadas para acesso as documentos

Responsável por gerar urls de arquivo XML e DANFe

path Parameters
id
required
string

Identificador único (UUID) do invoice.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Cancelamento

Responsável pelo cancelamento de NFe.

path Parameters
id
required
string

Identificador único (UUID) do invoice.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
optional

Carga útil com dados de uma requisição para cancelamento da nota.

justification
string

Justificativa de cancelamento

Responses

Request samples

Content type
application/json
{
  • "justification": "Teste de Cancelamento de NFe utilizando o Reneotec"
}

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Inutilização

Responsável pela inutilização de numerações de NFe.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para inutilização de notas.

series
number

Série de NFe

year
number

Ano de ocorrência da quebrada de sequência

justification
string

Justificativa de inutilização

environment
string

Código do ambiente 1- "PRODUÇÃO" ou 2- "HOMOLOGAÇÃO"

numberingInitial
number

Numeração inicial a ser inutilizada, No caso de inutilização de um único número, o número inicial e final devem ser iguais.

numberingFinal
number

Numeração final a ser inutilizada.

Responses

Request samples

Content type
application/json
{
  • "series": 1,
  • "year": 2024,
  • "justification": "Teste de Inutilização de NFe de numeração 000000001 utilizando o Reneotec",
  • "environment": "2",
  • "numberingInitial": 1,
  • "numberingFinal": 1
}

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Carta de Correção

Responsável pelo evento de carta de correção de NFe.

path Parameters
id
required
string

Identificador único (UUID) do invoice.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
optional

Carga útil com dados de uma requisição para correção da nota.

justification
string

texto da correção, A carta de correção com data mais recente substitui as cartas de correções existentes, assim o texto deve consolidar todas as correções.

Responses

Request samples

Content type
application/json
{
  • "justification": "O periodo de referencia de lançamento da NF-e de ativo permanente foi informado indevidamente como sendo \"ref.: JUNHO/2024\", considerar o periodo como \"ref.: JULHO/2024\"."
}

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Certificate

Exemplos de operações com recursos de certificado digital

Listar certificados digitais

Responsável por exibir dados certificate

query Parameters
id
string

filtro pelo Id do Certificado Digital

emitterID
string

filtro pelo emitente responsável do Certificado Digital

updateAt
string

filtro pela data de atualização do Certificado Digital

object

filtro pelas datas do Certificado Digital

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de certificado digital

Responsável por adicionar um certificate na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: multipart/form-data
required

Carga útil com dados de uma requisição para incluir um novo certificado digital.

emitterID
required
string

identificação do emitente responsável pelo Certificado Digital

password
required
string

senha de registro do Certificado Digital

file
file .pfx

arquivo do Certificado Digital

Responses

Request samples

Content type
multipart/form-data
{
  "emitterID": "6ec36774-1263-41dd-b96b-dbc3f8605c3c",
  "password": "12356",
  "file": "certificado.pfx"
}

Response samples

Content type
application/json
{
  • "id": "28ad3a81-4c53-45e8-a381-26a49403aeb3",
  • "emitterID": "6ec36774-1263-41dd-b96b-dbc3f8605c3c",
  • "updateAt": "2023.12.01",
  • "description": "AR PRIMUS",
  • "validDate": {
    }
}

Remover certificado digital

Responsável por remover dados certificate

path Parameters
id
required
string

Identificador único (UUID) do certificador digital.

header Parameters
Authorization
required
string

token - Token de autenticação.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Alteração de certificado digital.

Responsável por alterar informações de certificate na base.

path Parameters
id
required
string

Identificador único (UUID) da transportadora.

header Parameters
Authorization
required
jwt

token - Token de autenticação.

Request Body schema: multipart/form-data
required

Carga útil com dados de uma requisição para incluir alterações de certificado.

password
required
string

senha de registro do Certificado Digital.

file
file .pfx

arquivo do Certificado Digital

Responses

Request samples

Content type
multipart/form-data
{
  "password": "12356",
  "file": "certificado.pfx"
}

Response samples

Content type
application/json
{
  • "id": "ed1170c0-ac64-4505-a233-15d42d5b69f3",
  • "emitterID": "5e89ebb1-e73f-47c0-b46d-ef802a22c425",
  • "description": "SECRETARIA DA RECCEITA FEDERAL DO BRASIL",
  • "updateAt": "2023.12.01",
  • "validDate": {
    }
}

TaxProfile

Exemplos de operações com recursos de perfil tributário

Listar perfil tributário

Endpoint para listagem de todos os perfis tributários

query Parameters
id
string <uuid>

filtro pelo codigo de identificação do taxProfile.

emitterID
string <uuid>

filtro pelo codigo de identificação do emitente

object

filtro pelo bloco product do 'invoice'.

object

filtro pelo bloco remittee do 'taxprofile'.

operationType
string

filtro pelo operationType do operation

natureOfOperation
string

filtro pelo natureOfOperation do operation

destination
string

filtro pelo destination do operation

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token de autorização.

Request Body schema: application/json
optional

Carga útil com dados para filtro de perfil tributário.

object

Dados do emitente

object

Dados do remetente.

object

Informações sobre o produto.

operationType
SAIDA or ENTRADA

indicador de operação.

destination
UsoConsumo or Revenda or Devolucao-Fornecedor or Compra or Garantia or Industrializacao or Transferencia

destinação do perfil tributário.

natureOfOperation
SALE or DEVOLUTION or SHIPPING or RETURN or BONUS

natureza da operação.

Responses

Request samples

Content type
application/json
{
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "Revenda"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Criar novo perfil tributário

Responsável por criar um novo perfil tributário

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de um perfil tributário.

emitterID
required
string <uuid>

Identificador do emitente.

description
required
string

Descrição resumida do perfil.

required
object

Dados do emitente.

required
object

Dados do remetente.

required
object

Informações sobre o produto.

operationType
required
SAIDA or ENTRADA

indicador de operação.

destination
required
UsoConsumo or Revenda or Devolucao-Fornecedor or Compra or Garantia or Industrializacao or Transferencia

destinação do perfil tributário.

natureOfOperation
required
SALE or DEVOLUTION or SHIPPING or RETURN or BONUS

natureza da operação.

Responses

Request samples

Content type
application/json
{
  • "description": "Perfil Tributário - Teste",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "UsoConsumo"
}

Response samples

Content type
application/json
{
  • "id": "ec89195c-c857-4e3d-9a39-9c032820a38a",
  • "emitterID": "bc114e4a-d643-4acc-87af-35553b2f0ff7",
  • "description": "Perfil Tributário - Teste",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "UsoConsumo"
}

Excluir perfil tributário

Responsável por excluir registro do perfil.

path Parameters
id
required
string

Identificador único (UUID) do perfil.

header Parameters
Authorization
required
string

token de autorização.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Alteração de perfil tributário.

Responsável por alterar elementos do perfil tributário.

path Parameters
id
required
string

Identificador único (UUID) do perfil.

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de um perfil.

description
string

Descrição resumida do perfil.

object

Dados do emitente.

object

Dados do remetente.

object

Informações sobre o produto.

operationType
SAIDA or ENTRADA

indicador de operação.

destination
UsoConsumo or Revenda or Devolucao-Fornecedor or Compra or Garantia or Industrializacao or Transferencia

destinação do perfil tributário.

natureOfOperation
SALE or DEVOLUTION or SHIPPING or RETURN or BONUS

natureza da operação.

Responses

Request samples

Content type
application/json
{
  • "description": "Perfil Tributário - Teste",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "UsoConsumo"
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "emitterID": "8e948edb-8d52-4196-90eb-83cc489d9eee",
  • "description": "Perfil Tributário - Exemplo de Alteração",
  • "emitter": {
    },
  • "remittee": {
    }
}

Operation

Exemplos de operações com recursos de perfil tributário do Emitter

Listar perfil tributário do Emitter

Endpoint para listagem de todos os perfis tributários de um determinado Emitter

query Parameters
id
string <uuid>

filtro pelo codigo de identificação do taxProfile.

emitterID
required
string <uuid>

filtro pelo ID do emitter do Operation.

header Parameters
Authorization
required
string <jwt>

token de autorização.

Request Body schema: application/json
required

Carga útil com dados para filtro de perfil tributário do emitter.

emitterID
uuid

ID do emitente

object

Dados do emitente

object

Dados do remetente.

object

Informações sobre o produto.

operationType
SAIDA or ENTRADA

indicador de operação.

destination
UsoConsumo or Revenda or Devolucao-Fornecedor or Compra or Garantia or Industrializacao or Transferencia

destinação do perfil tributário.

natureOfOperation
SALE or DEVOLUTION or SHIPPING or RETURN or BONUS

natureza da operação.

Responses

Request samples

Content type
application/json
{
  • "emitterID": "0b6e9097-d658-4c41-9146-caf5f1d06085",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "Revenda"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Criar novo perfil tributário do emitter

Responsável por criar um novo perfil tributário do emitter

Request Body schema: application/json
required

Carga útil com dados de uma requisição para criação de um perfil tributário.

emitterID
required
string <uuid>

Identificador do emitente.

description
required
string

Descrição resumida do perfil.

required
object

Dados do emitente.

required
object

Dados do remetente.

required
object

Informações sobre o produto.

operationType
required
SAIDA or ENTRADA

indicador de operação.

destination
required
UsoConsumo or Revenda or Devolucao-Fornecedor or Compra or Garantia or Industrializacao or Transferencia

destinação do perfil tributário.

natureOfOperation
required
SALE or DEVOLUTION or SHIPPING or RETURN or BONUS

natureza da operação.

Responses

Request samples

Content type
application/json
{
  • "description": "Perfil Tributário - Teste",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "UsoConsumo"
}

Response samples

Content type
application/json
{
  • "id": "ec89195c-c857-4e3d-9a39-9c032820a38a",
  • "emitterID": "bc114e4a-d643-4acc-87af-35553b2f0ff7",
  • "description": "Perfil Tributário - Teste",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "UsoConsumo"
}

Excluir perfil tributário do emitter

Responsável por excluir registro do perfil.

path Parameters
id
required
string

Identificador único (UUID) do perfil.

header Parameters
Authorization
required
string

token de autorização.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Alteração de perfil tributário do emitter.

Responsável por alterar elementos do perfil tributário.

path Parameters
id
required
string

Identificador único (UUID) do perfil.

query Parameters
emitterID
string <uuid>

filtro pelo codigo de identificação do emitente

header Parameters
Authorization
required
string

token de autorização.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para alteração de um perfil de uma emitter.

description
string

Descrição resumida do perfil do emitter.

object

Dados do emitente.

object

Dados do remetente.

object

Informações sobre o produto.

operationType
SAIDA or ENTRADA

indicador de operação.

destination
UsoConsumo or Revenda or Devolucao-Fornecedor or Compra or Garantia or Industrializacao or Transferencia

destinação do perfil tributário.

natureOfOperation
SALE or DEVOLUTION or SHIPPING or RETURN or BONUS

natureza da operação.

Responses

Request samples

Content type
application/json
{
  • "description": "Perfil Tributário - Teste",
  • "emitter": {
    },
  • "remittee": {
    },
  • "product": {
    },
  • "operationType": "SAIDA",
  • "natureOfOperation": "SALE",
  • "destination": "UsoConsumo"
}

Response samples

Content type
application/json
{
  • "id": "df79c85a-65ea-4130-97f7-e41025ade566",
  • "emitterID": "8e948edb-8d52-4196-90eb-83cc489d9eee",
  • "description": "Perfil Tributário - Exemplo de Alteração",
  • "emitter": {
    },
  • "remittee": {
    }
}

IBPT

Exemplos de operações com recursos de IBPT

Listar ibpt

Responsável por listar ibpt

query Parameters
codigo
string

filtro pelo codigo NCM.

id
string

filtro pelo codigo de identificação do 'ibpt'.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de ibpt

Responsável por adicionar um novo ibpt na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo ibpt.

uf
required
string

estado.

codigo
required
string

Código NCM.

ex
required
string

Grau de produto importado.

tipo
required
string

Tipo.

descricao
required
string

Descrição do NCM do produto.

nacionalfederal
required
number

imposto nacional federal.

importadosfederal
required
number

imposto nacional importado.

estadual
required
number

imposto estadual.

municipal
required
number

imposto municipal.

vigenciainicio
required
date

Data inicial de vigência.

vigenciafim
required
date

Data final de vigência.

chave
required
string

Chave da versão.

versao
required
string

Versão.

fonte
required
string

Fonte dos dados.

Responses

Request samples

Content type
application/json
{
  • "uf": "SP",
  • "codigo": "00000000",
  • "ex": "",
  • "tipo": "0",
  • "descricao": "PRODUTO NAO ESPECIFICADO NA LISTA DE NCM 1",
  • "nacionalfederal": 7.85,
  • "importadosfederal": 9.85,
  • "estadual": 18,
  • "municipal": 0,
  • "vigenciainicio": "2024-04-20",
  • "vigenciafim": "2024-03-31",
  • "chave": "4B7157",
  • "versao": "24.1.B",
  • "fonte": "IBPT/empresometro.com.br"
}

Response samples

Content type
application/json
{
  • "id": "82df9bbe-42e6-4284-bece-099b2c8e1e81",
  • "uf": "SP",
  • "codigo": "00000000",
  • "ex": "",
  • "tipo": "0",
  • "descricao": "PRODUTO NAO ESPECIFICADO NA LISTA DE NCM 1",
  • "nacionalfederal": 7.85,
  • "importadosfederal": 9.85,
  • "estadual": 18,
  • "municipal": 0,
  • "vigenciainicio": "2024-04-20",
  • "vigenciafim": "2024-03-31",
  • "chave": "4B7157",
  • "versao": "24.1.B",
  • "fonte": "IBPT/empresometro.com.br"
}

Billing

Listar pagamento

Responsável por listar emitter

query Parameters
loginOwnerID
string

filtro pelo ID do Login do Owner.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de pagamento

Responsável por adicionar um novo emitter na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo pagamento.

id
string

ID do pagamento.

codigoPagamentoIntegrado
required
string

Codigo pagamento integrado.

dataHora
required
string

Data hora do pagamento.

required
object

Informação do valor de pagamento.

required
object

Informação do vendedor do pagamento.

required
object

Informação do consumidor do pagamento.

required
object

Informação do produtos do pagamento.

required
object

Informação do pagamento.

billingID
required
string

ID do billing.

loginOwnerID
required
string

ID do login do dono da conta.

object

Informações da Compra Recorrente.

Responses

Request samples

Content type
application/json
{
  • "id": "",
  • "codigoPagamentoIntegrado": "6b2164d3-7b16-4370-8344-735a8ebc9a3a",
  • "dataHora": "2024-04-30 19:40:19",
  • "valores": {
    },
  • "vendedor": {
    },
  • "consumidor": {
    },
  • "produtos": [
    ],
  • "pagamento": {
    },
  • "billingID": "6b2164d3-7b16-4370-8344-735a8ebc9a3a",
  • "loginOwnerID": "78d34b11-22a6-4af7-9903-b94c0980d1a0",
  • "compraRecorrente": {
    }
}

Response samples

Content type
application/json
{
  • "id": "",
  • "codigoPagamentoIntegrado": "6b2164d3-7b16-4370-8344-735a8ebc9a3a",
  • "dataHora": "2024-04-30 19:40:19",
  • "valores": {
    },
  • "vendedor": {
    },
  • "consumidor": {
    },
  • "produtos": [
    ],
  • "pagamento": {
    },
  • "billingID": "6b2164d3-7b16-4370-8344-735a8ebc9a3a",
  • "loginOwnerID": "78d34b11-22a6-4af7-9903-b94c0980d1a0",
  • "compraRecorrente": {
    }
}

Plan

Listar plan

Responsável por listar plan

query Parameters
id
string

filtro pelo codigo de identificação do plano.

name
string

filtro pelo nome do plano.

offset
integer >= 1
Example: offset=25

define o índice inicial da pesquisa

limit
integer [ 1 .. 50 ]
Example: limit=10

limite máximo de registros a serem apresentados

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

Cadastro de plan

Responsável por adicionar um novo plan na base.

header Parameters
Authorization
required
string <jwt>

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo plan.

name
required
string

Nome do plano.

renovation
required
boolean

Identificação do plano renovável.

active
required
boolean

Estado do plano (Ativo ou inativo).

trial
required
boolean

Identificação do plano trial.

required
Array of objects

Identificação dos períodos do plano.

Responses

Request samples

Content type
application/json
{
  • "name": "basic",
  • "renovation": true,
  • "active": true,
  • "trial": false,
  • "periods": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "50c87a76-3360-4875-a44b-072608a0d0b2",
  • "name": "basic",
  • "renovation": true,
  • "active": true,
  • "trial": false,
  • "periods": [
    ]
}

Alteração de plano

Responsável por alterar informações de plan na base.

path Parameters
id
required
string

Identificador único (UUID) do plano.

header Parameters
Authorization
required
string

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados de uma requisição para incluir um novo plano.

name
string

Nome do plano.

renovation
boolean

Identificação do plano renovável.

active
boolean

Estado do plano (Ativo ou inativo).

trial
boolean

Identificação do plano trial.

Array of objects

Identificação dos períodos do plano.

Responses

Request samples

Content type
application/json
{
  • "name": "basic",
  • "renovation": true,
  • "active": true,
  • "trial": false,
  • "periods": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "50c87a76-3360-4875-a44b-072608a0d0b2",
  • "name": "basic",
  • "renovation": true,
  • "active": true,
  • "trial": false,
  • "periods": [
    ]
}

Exclusão de plano

Responsável por remover plan da base.

path Parameters
id
required
string

Identificador único (UUID) da transportadora.

header Parameters
Authorization
required
string

token - Token de autenticação.

Responses

Response samples

Content type
application/problem+json
{
  • "message": "erro na validação da entidade",
  • "errors": [
    ]
}

Calculation

Calcular impostos como ICMS, Pis, Cofins, IBPT...

Responsável por calculo de impostos.

header Parameters
Authorization
required
string

token - Token de autenticação.

Request Body schema: application/json
required

Carga útil com dados para calculo do Imposto.

Array of objects

identificação do produto.

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "products": [
    ]
}