API docs by Redocly

Sereny - Vendas (1.0.0)

Download OpenAPI specification:Download

Sistema de atendimento ao cliente: sac@sereny.dev.br URL: https://serenyvendas.com.br License: Apache 2.0

Introdução

Este guia visa esclarecer questões da API como autenticação, formatos e parâmetros aceitos.

Campos

Listar campos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar campo

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
title
required
string

Título do campo

field_type
required
string
Enum: "boolean" "date" "datetime" "integer" "float" "string" "text" "list"

Define o tipo do campo

scope
required
string
Enum: "activity" "contact" "order" "order_line"

Define aonde estará disponível o campo

  • activity - Disponível nas Atividades
  • contact - Disponível nos Contatos
  • order - Disponível nas Documentos
  • order_line - Disponível nos Itens do documento
required
required
boolean

Define se o campo deve ter preenchimento obrigatório

multiple
boolean

Define se o campo é uma lista de seleção múltipla

values
string

Valores para da lista

default_value
string

Valor padrão

mim_value
number

Valor mínimo

max_value
number

Valor máximo

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "field_type": "boolean",
  • "scope": "activity",
  • "required": true,
  • "multiple": true,
  • "values": "string",
  • "default_value": "string",
  • "mim_value": 0,
  • "max_value": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar campo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
title
required
string

Título do campo

field_type
required
string
Enum: "boolean" "date" "datetime" "integer" "float" "string" "text" "list"

Define o tipo do campo

scope
required
string
Enum: "activity" "contact" "order" "order_line"

Define aonde estará disponível o campo

  • activity - Disponível nas Atividades
  • contact - Disponível nos Contatos
  • order - Disponível nas Documentos
  • order_line - Disponível nos Itens do documento
required
required
boolean

Define se o campo deve ter preenchimento obrigatório

multiple
boolean

Define se o campo é uma lista de seleção múltipla

values
string

Valores para da lista

default_value
string

Valor padrão

mim_value
number

Valor mínimo

max_value
number

Valor máximo

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "field_type": "boolean",
  • "scope": "activity",
  • "required": true,
  • "multiple": true,
  • "values": "string",
  • "default_value": "string",
  • "mim_value": 0,
  • "max_value": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter campo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir Campo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Categorias

Listar categorias

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar categoria

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da categoria

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar categoria

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da categoria

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter categoria

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir categoria

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Condições de pagamento

Listar condições de pagamento

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar condição de pagamento

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da condição de pagamento

installments
required
integer

Quantidade de parcelas

min_installment
number

Valor mínimo da parcela do documento

min_order
number

Valor total mínimo do documento

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "installments": 0,
  • "min_installment": 0,
  • "min_order": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar condição de pagamento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da condição de pagamento

installments
required
integer

Quantidade de parcelas

min_installment
number

Valor mínimo da parcela do documento

min_order
number

Valor total mínimo do documento

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "installments": 0,
  • "min_installment": 0,
  • "min_order": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter condições de pagamento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir condição de pagamento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Contatos

Listar contatos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar contato

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
contact_type
string
Enum: "person" "company"

Define o tipo do contato

  • person - Pessoa física
  • company - Pessoa jurídica
name
required
string

Nome do contato

company_name
string

Nome fantasia do contato

group_id
string

Código identificador referente ao grupo do contato

doc_primary
string

Número do CPF/CNPJ

doc_secondary
string

Número do RG./IE.

credit_provided
number >= 0

Valor de crédito aprovado para o contato

credit_utilization
number >= 0

Valor de crédito utilizado para o contato

notes
string

Observação do contato

username
string

Login de acesso

password
string

senha de acesso

is_company
boolean

Define se o contato é uma empresa

is_customer
boolean

Define se o contato é consumidor final

is_active
boolean

Define se o contato está ativo

emails
Array of strings <email> [ items <email > ]
phones
Array of strings
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "contact_type": "person",
  • "name": "string",
  • "company_name": "string",
  • "group_id": "string",
  • "doc_primary": "string",
  • "doc_secondary": "string",
  • "credit_provided": 0,
  • "credit_utilization": 0,
  • "notes": "string",
  • "username": "string",
  • "password": "string",
  • "is_company": true,
  • "is_customer": true,
  • "is_active": true,
  • "emails": [
    ],
  • "phones": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
contact_type
string
Enum: "person" "company"

Define o tipo do contato

  • person - Pessoa física
  • company - Pessoa jurídica
name
required
string

Nome do contato

company_name
string

Nome fantasia do contato

group_id
string

Código identificador referente ao grupo do contato

doc_primary
string

Número do CPF/CNPJ

doc_secondary
string

Número do RG./IE.

credit_provided
number >= 0

Valor de crédito aprovado para o contato

credit_utilization
number >= 0

Valor de crédito utilizado para o contato

notes
string

Observação do contato

username
string

Login de acesso

password
string

senha de acesso

is_company
boolean

Define se o contato é uma empresa

is_customer
boolean

Define se o contato é consumidor final

is_active
boolean

Define se o contato está ativo

emails
Array of strings <email> [ items <email > ]
phones
Array of strings
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "contact_type": "person",
  • "name": "string",
  • "company_name": "string",
  • "group_id": "string",
  • "doc_primary": "string",
  • "doc_secondary": "string",
  • "credit_provided": 0,
  • "credit_utilization": 0,
  • "notes": "string",
  • "username": "string",
  • "password": "string",
  • "is_company": true,
  • "is_customer": true,
  • "is_active": true,
  • "emails": [
    ],
  • "phones": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar endereços do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar endereço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
is_primary
required
boolean

Define se é o endereço principal

postcode
required
string

Número do CEP do endereço

street
required
string

Descrição do endereço

number
string

Número do endereço

district
string

Nome do bairro do endereço

details
string

Complemento do endereço

city
required
string.*?-\s*[A-Z]{2}$

Nome da cidade

state
required
string

UF do estado

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "is_primary": true,
  • "postcode": "string",
  • "street": "string",
  • "number": "string",
  • "district": "string",
  • "details": "string",
  • "city": "string",
  • "state": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar endereço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
is_primary
required
boolean

Define se é o endereço principal

postcode
required
string

Número do CEP do endereço

street
required
string

Descrição do endereço

number
string

Número do endereço

district
string

Nome do bairro do endereço

details
string

Complemento do endereço

city
required
string.*?-\s*[A-Z]{2}$

Nome da cidade

state
required
string

UF do estado

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "is_primary": true,
  • "postcode": "string",
  • "street": "string",
  • "number": "string",
  • "district": "string",
  • "details": "string",
  • "city": "string",
  • "state": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter endereço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir endereço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar títulos do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar título do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
number
required
string

Número do título

invoice_date
required
string
due_date
string
link
string <url>

Link de acesso a nota fiscal

notes
string

Observação do título

total
required
number

Valor total do título

paid
required
number

Valor pago do título

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "link": "string",
  • "notes": "string",
  • "total": 0,
  • "paid": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar título do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
number
required
string

Número do título

invoice_date
required
string
due_date
string
link
string <url>

Link de acesso a nota fiscal

notes
string

Observação do título

total
required
number

Valor total do título

paid
required
number

Valor pago do título

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "link": "string",
  • "notes": "string",
  • "total": 0,
  • "paid": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter título do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir título do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar tipos do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular tipo ao contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter tipos do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir tipo do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar formas de pagamento do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular forma de pagamento ao contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter forma de pagamento do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir forma de pagamento do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar condições de pagamento do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular condição de pagamento ao contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter condição de pagamento do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir condição de pagamento do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar tabelas de preço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular tabela de preço ao contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter tabela de preço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir tabela de preço do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar unidades do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular uniade ao contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter unidades do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir unidade do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar anexos do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar anexo do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: multipart/form-data
files
required
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
"string"

Obter anexo do contato

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
"string"

Depósitos

Listar depósitos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar depósito

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do depósito

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar depósito

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do depósito

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter depósito

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir depósito

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Formas de pagamento

Listar formas de pagamento

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar forma de pagamento

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da forma de pagamento

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar forma de pagamento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da forma de pagamento

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir forma de pagamento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Grupos

Listar grupos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar grupo

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do grupo

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar grupo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do grupo

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter grupo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir grupo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Impostos

Listar impostos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar impostos

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
tax_type
required
string
Enum: "st" "ipi"

Define tipo do cálculo de impostos

  • st - Cálculo de substituição tributária
  • ipi - Cálculo de IPI
state
string

UF do estado

category_id
string <uuid>

Código identificador referente a categoria

tracker_id
string <uuid>

Código identificador referente ao tipo

product_id
string <uuid>

Código identificador referete ao produto

contact_group_id
string <uuid>

Código identificador referente ao grupo do contato

product_group_id
string <uuid>

Código identificador referente ao grupo do produto

ncm
string <= 8 characters

NCM do produto

mva
number

Percentual da alíquota de MVA

fcp
number

Percentual da alíquota de FCP

ipi
number

Percentual da alíquota de IPI

icms_source
number

Percentual da alíquota de ICMS de origem

icms_target
number

Percentual da alíquota de ICMS de destino

position
number

Índice de ordenação

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "tax_type": "st",
  • "state": "string",
  • "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  • "tracker_id": "4d678ae8-4a84-4e82-bf40-4120fe900609",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
  • "product_group_id": "aead7b4f-5376-446b-9cf1-460361ea1a63",
  • "ncm": "string",
  • "mva": 0,
  • "fcp": 0,
  • "ipi": 0,
  • "icms_source": 0,
  • "icms_target": 0,
  • "position": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar imposto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
tax_type
required
string
Enum: "st" "ipi"

Define tipo do cálculo de impostos

  • st - Cálculo de substituição tributária
  • ipi - Cálculo de IPI
state
string

UF do estado

category_id
string <uuid>

Código identificador referente a categoria

tracker_id
string <uuid>

Código identificador referente ao tipo

product_id
string <uuid>

Código identificador referete ao produto

contact_group_id
string <uuid>

Código identificador referente ao grupo do contato

product_group_id
string <uuid>

Código identificador referente ao grupo do produto

ncm
string <= 8 characters

NCM do produto

mva
number

Percentual da alíquota de MVA

fcp
number

Percentual da alíquota de FCP

ipi
number

Percentual da alíquota de IPI

icms_source
number

Percentual da alíquota de ICMS de origem

icms_target
number

Percentual da alíquota de ICMS de destino

position
number

Índice de ordenação

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "tax_type": "st",
  • "state": "string",
  • "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  • "tracker_id": "4d678ae8-4a84-4e82-bf40-4120fe900609",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
  • "product_group_id": "aead7b4f-5376-446b-9cf1-460361ea1a63",
  • "ncm": "string",
  • "mva": 0,
  • "fcp": 0,
  • "ipi": 0,
  • "icms_source": 0,
  • "icms_target": 0,
  • "position": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter imposto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir imposto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Lotes

Listar lotes

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar lote

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do lote

validity_date
string <date>

Data de validade do lote

code
required
string

Número do lote

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "validity_date": "2019-08-24",
  • "code": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar lote

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do lote

validity_date
string <date>

Data de validade do lote

code
required
string

Número do lote

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "validity_date": "2019-08-24",
  • "code": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter lote

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir lote

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Criar roteiro

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do roteiro

track_type
required
string
Enum: "monthly" "weekly" "dayly"

Define o tipo do roteiro

  • monthly - Mensal
  • weekly - Semanal
  • dayly - Diário
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "track_type": "monthly",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Marcadores

Listar marcadores

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar marcador

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do marcador

color
required
string

Codificação hexa decimal da cor

scope
required
string
Enum: "contact" "product" "order"

Define o destino da utilização do marcador

  • contact - Os marcadores serão exibidos nos contatos
  • product - Os marcadores serão exibidos nos produtos
  • order - Os marcaores serão exibidos nas vendas
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "color": "string",
  • "scope": "contact",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar marcador

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do marcador

color
required
string

Codificação hexa decimal da cor

scope
required
string
Enum: "contact" "product" "order"

Define o destino da utilização do marcador

  • contact - Os marcadores serão exibidos nos contatos
  • product - Os marcadores serão exibidos nos produtos
  • order - Os marcaores serão exibidos nas vendas
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "color": "string",
  • "scope": "contact",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter marcador

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir marcador

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Metas

Listar metas

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar meta

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da meeta

base_date
required
string <date>

Primeiro dia do mês base da meta

amount
required
number

Valor monetário do objetivo da meta

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "base_date": "2019-08-24",
  • "amount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da meeta

base_date
required
string <date>

Primeiro dia do mês base da meta

amount
required
number

Valor monetário do objetivo da meta

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "base_date": "2019-08-24",
  • "amount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar tipos da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular tipo a meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter tipos da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir tipo da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar status da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular status a meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter status da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir status da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Listar produtos da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Vincular produtos a meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
resources
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

Obter produto da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir produto da meta

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Produtos

Listar produtos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar produto

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do produto

code
required
string

Número único identificador do produto

barcode
string

Código de barras

notes
string

Observação do produto

category_id
required
string

Código identificador referente a categoria

group_id
string

Código identificador referente ao grupo

unit_quantity
number >= 1
Default: 1

Base de multiplicação para incrementar a quantidade de unidades no lançamento do pedido.
Isso significa que a quantidade permitida na inclusão de um item no pedido deve ser múltipla deste número.
Exemplo: Um produto defindo com unit_quantity: 2, será permitido apenas as quantidades de: 2,4,8,16...

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "barcode": "string",
  • "notes": "string",
  • "category_id": "string",
  • "group_id": "string",
  • "unit_quantity": 1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do produto

code
required
string

Número único identificador do produto

barcode
string

Código de barras

notes
string

Observação do produto

category_id
required
string

Código identificador referente a categoria

group_id
string

Código identificador referente ao grupo

unit_quantity
number >= 1
Default: 1

Base de multiplicação para incrementar a quantidade de unidades no lançamento do pedido.
Isso significa que a quantidade permitida na inclusão de um item no pedido deve ser múltipla deste número.
Exemplo: Um produto defindo com unit_quantity: 2, será permitido apenas as quantidades de: 2,4,8,16...

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "barcode": "string",
  • "notes": "string",
  • "category_id": "string",
  • "group_id": "string",
  • "unit_quantity": 1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar conversões do produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar conversão do produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
unit_id
required
string

Código identificador referente a unidade

factor
required
number

Fator de conversão

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "unit_id": "string",
  • "factor": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar conversão do produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
unit_id
required
string

Código identificador referente a unidade

factor
required
number

Fator de conversão

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "unit_id": "string",
  • "factor": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter conversão do produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir conversão do produto

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Roteiros

Listar roteiros

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Alterar roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do roteiro

track_type
required
string
Enum: "monthly" "weekly" "dayly"

Define o tipo do roteiro

  • monthly - Mensal
  • weekly - Semanal
  • dayly - Diário
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "track_type": "monthly",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar itens do roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar item do roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
contact_id
required
string

Código identificador referente ao contato

position
number

Índice de ordenação

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "contact_id": "string",
  • "position": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar item do roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
contact_id
required
string

Código identificador referente ao contato

position
number

Índice de ordenação

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "contact_id": "string",
  • "position": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter item do roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir item do roteiro

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Transportadoras

Listar Transportadoras

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar transportadora

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
name
required
string

Razão social da transportadora

company_name
string

Nome fantasia da transportadora

doc_primary
string

CNPJ da transportadoras

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_name": "string",
  • "doc_primary": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar transportadora

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
name
required
string

Razão social da transportadora

company_name
string

Nome fantasia da transportadora

doc_primary
string

CNPJ da transportadoras

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_name": "string",
  • "doc_primary": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter Transportora

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir transportadora

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Situações

Listar situações

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar situação

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da situação

color
required
string

Codificação hexa decimal da cor

scope
string
Enum: "activity" "order"

Define em qual fincionalidade estará disponível o status

  • activity - Disponível nas Atividades
  • order - Disponível nas Documentos
notification_target
required
string
Enum: "none" "contact" "user" "all"

Define para quem será enviado email de notificação

  • none - Não será enviado email
  • contact - Email será enviado ao cliente do documento
  • user - Email será enviado ao representante responsável
  • all - Email será enviado ao cliente e ao representante
notification_extra
string

emails extras que deverão ser notificados

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "color": "string",
  • "scope": "activity",
  • "notification_target": "none",
  • "notification_extra": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar situação

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da situação

color
required
string

Codificação hexa decimal da cor

scope
string
Enum: "activity" "order"

Define em qual fincionalidade estará disponível o status

  • activity - Disponível nas Atividades
  • order - Disponível nas Documentos
notification_target
required
string
Enum: "none" "contact" "user" "all"

Define para quem será enviado email de notificação

  • none - Não será enviado email
  • contact - Email será enviado ao cliente do documento
  • user - Email será enviado ao representante responsável
  • all - Email será enviado ao cliente e ao representante
notification_extra
string

emails extras que deverão ser notificados

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "color": "string",
  • "scope": "activity",
  • "notification_target": "none",
  • "notification_extra": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter situação

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir situação

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Tabelas de preço

Listar tabelas de preço

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar tabela de preço

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da tabela de preço

validity_min
string <date>

Data inicial da validade da tabela de preço

validity_max
string <date>

Data final da validade da tabela de preço

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "validity_min": "2019-08-24",
  • "validity_max": "2019-08-24",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da tabela de preço

validity_min
string <date>

Data inicial da validade da tabela de preço

validity_max
string <date>

Data final da validade da tabela de preço

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "validity_min": "2019-08-24",
  • "validity_max": "2019-08-24",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar itens da tabelas de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar item da tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
product_id
required
string

Código identificador referente ao produto

value
required
number

Preço de venda o produto

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "value": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar item da tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
product_id
required
string

Código identificador referente ao produto

value
required
number

Preço de venda o produto

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "value": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter item tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir item da tabela de preço

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Tipos

Listar tipos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar tipo

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
object (Tracker)

Estrutura do tipo

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar tipo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição do tipo

inventory
required
boolean

Determina se o tipo deve restringir a venda de produtos sem estoque

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "inventory": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter tipo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir tipo

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Unidades

Listar unidades

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar unidade

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da unidade

code
required
string

Sigla da unidade

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar unidade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
description
required
string

Descrição da unidade

code
required
string

Sigla da unidade

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter unidade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir unidade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Atividades

Listar atividades

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar atividade

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
subject
required
string

Assunto da atividade

contact_id
required
string

Código identificador referente ao contato

user_id
required
string

Código identificador referente ao usuário

status_id
required
string

Código identificador referete a situação

tracker_id
required
string

Código identificador referente ao tipo

start_date
required
string <datetime>

Date de início da atividade

end_date
required
string <datetime>

Date de término da atividade

notes
string

Descrição da atividade

is_done
boolean

Indica se a atividade foi realizada

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "contact_id": "string",
  • "user_id": "string",
  • "status_id": "string",
  • "tracker_id": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "notes": "string",
  • "is_done": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
subject
required
string

Assunto da atividade

contact_id
required
string

Código identificador referente ao contato

user_id
required
string

Código identificador referente ao usuário

status_id
required
string

Código identificador referete a situação

tracker_id
required
string

Código identificador referente ao tipo

start_date
required
string <datetime>

Date de início da atividade

end_date
required
string <datetime>

Date de término da atividade

notes
string

Descrição da atividade

is_done
boolean

Indica se a atividade foi realizada

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "contact_id": "string",
  • "user_id": "string",
  • "status_id": "string",
  • "tracker_id": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "notes": "string",
  • "is_done": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar anexos da atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar anexo da atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: multipart/form-data
files
required
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
"string"

Obter anexo da atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
"string"

Excluir anexo da atividade

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Documentos

Listar documentos

Authorizations:
BasicAuthBearerAuth
query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar documento

Authorizations:
BasicAuthBearerAuth
header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
document_type
required
string
Value: "order"

Define o tipo do documento

  • order - Pedido de venda
number
string

Número do documento

contact_id
required
string

Código identificador do contato do documento

user_id
required
string

Código identificador do usuário responsável pelo documento

tracker_id
required
string

Código identificador do tipo do documento

status_id
required
string

Código identificador da situação do documento

price_id
required
string

Código identificador da tabela de preço do documento

shipper_id
string

Código identificador do transportador do documento

payment_method_id
required
string

Código identificador da forma de pagamento

payment_term_id
required
string

Código identificador da condição de pagamento

delivery_date
string <datetime>

Data/hora de previsão de entrega do documento

validity_date
string <date>

Data de validade do documento

purchase_order
string

Número da ordem de compra

notes
string

Observação do documento

discount
number [ 0 .. 100 ]

Percentual de desconto do documento

addition
number [ 0 .. 100 ]

Percentual de acréscimo do documento

shipping_date
string <datetime>

Data de previsão de entrega da transportadora

shipping_link
string <uri>

Link de rastreamento da transportadora

shipping_value
number >= 0

Valor do frete

shipping_percent
number [ 0 .. 100 ]

Percentual do frete

shipping_type
string
Enum: "cif" "fob" "sender" "recipient"

Define o tipo do contato

  • cif - CIF
  • fob - FOB
  • sender - Próprio - remetente
  • recipient - Próprio - destinatário
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "document_type": "order",
  • "number": "string",
  • "contact_id": "string",
  • "user_id": "string",
  • "tracker_id": "string",
  • "status_id": "string",
  • "price_id": "string",
  • "shipper_id": "string",
  • "payment_method_id": "string",
  • "payment_term_id": "string",
  • "delivery_date": "string",
  • "validity_date": "2019-08-24",
  • "purchase_order": "string",
  • "notes": "string",
  • "discount": 100,
  • "addition": 100,
  • "shipping_date": "string",
  • "shipping_link": "http://example.com",
  • "shipping_value": 0,
  • "shipping_percent": 100,
  • "shipping_type": "cif",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
document_type
required
string
Value: "order"

Define o tipo do documento

  • order - Pedido de venda
number
string

Número do documento

contact_id
required
string

Código identificador do contato do documento

user_id
required
string

Código identificador do usuário responsável pelo documento

tracker_id
required
string

Código identificador do tipo do documento

status_id
required
string

Código identificador da situação do documento

price_id
required
string

Código identificador da tabela de preço do documento

shipper_id
string

Código identificador do transportador do documento

payment_method_id
required
string

Código identificador da forma de pagamento

payment_term_id
required
string

Código identificador da condição de pagamento

delivery_date
string <datetime>

Data/hora de previsão de entrega do documento

validity_date
string <date>

Data de validade do documento

purchase_order
string

Número da ordem de compra

notes
string

Observação do documento

discount
number [ 0 .. 100 ]

Percentual de desconto do documento

addition
number [ 0 .. 100 ]

Percentual de acréscimo do documento

shipping_date
string <datetime>

Data de previsão de entrega da transportadora

shipping_link
string <uri>

Link de rastreamento da transportadora

shipping_value
number >= 0

Valor do frete

shipping_percent
number [ 0 .. 100 ]

Percentual do frete

shipping_type
string
Enum: "cif" "fob" "sender" "recipient"

Define o tipo do contato

  • cif - CIF
  • fob - FOB
  • sender - Próprio - remetente
  • recipient - Próprio - destinatário
id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "document_type": "order",
  • "number": "string",
  • "contact_id": "string",
  • "user_id": "string",
  • "tracker_id": "string",
  • "status_id": "string",
  • "price_id": "string",
  • "shipper_id": "string",
  • "payment_method_id": "string",
  • "payment_term_id": "string",
  • "delivery_date": "string",
  • "validity_date": "2019-08-24",
  • "purchase_order": "string",
  • "notes": "string",
  • "discount": 100,
  • "addition": 100,
  • "shipping_date": "string",
  • "shipping_link": "http://example.com",
  • "shipping_value": 0,
  • "shipping_percent": 100,
  • "shipping_type": "cif",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar itens do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar item do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
product_id
required
string

Código identificador referente ao produto

location_id
string

Código identificador referente ao depósito

batch_id
string

Código identificador referete ao lote

unit_id
string

Código identificador referete a unidade

unit_quantity
required
number > 0

Quantidade de unidades do produto do item do documento

real_price
required
number > 0

Valor unitário utilizado no item do documento

addition
number [ 0 .. 100 ]

Precentual do acréscimo do item do documento

discount
number [ 0 .. 100 ]

Percentual do desconto do item do documento

commission
number >= 0

Alíquota de comissão

commission_value
number >= 0

Valor da comissão

purchase_order
string

Número da ordem de compra

purchase_sequence
string

Sequência da ordem de compra

notes
string

Observação do item

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "location_id": "string",
  • "batch_id": "string",
  • "unit_id": "string",
  • "unit_quantity": 0,
  • "real_price": 0,
  • "addition": 100,
  • "discount": 100,
  • "commission": 0,
  • "commission_value": 0,
  • "purchase_order": "string",
  • "purchase_sequence": "string",
  • "notes": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar item do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
product_id
required
string

Código identificador referente ao produto

location_id
string

Código identificador referente ao depósito

batch_id
string

Código identificador referete ao lote

unit_id
string

Código identificador referete a unidade

unit_quantity
required
number > 0

Quantidade de unidades do produto do item do documento

real_price
required
number > 0

Valor unitário utilizado no item do documento

addition
number [ 0 .. 100 ]

Precentual do acréscimo do item do documento

discount
number [ 0 .. 100 ]

Percentual do desconto do item do documento

commission
number >= 0

Alíquota de comissão

commission_value
number >= 0

Valor da comissão

purchase_order
string

Número da ordem de compra

purchase_sequence
string

Sequência da ordem de compra

notes
string

Observação do item

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "location_id": "string",
  • "batch_id": "string",
  • "unit_id": "string",
  • "unit_quantity": 0,
  • "real_price": 0,
  • "addition": 100,
  • "discount": 100,
  • "commission": 0,
  • "commission_value": 0,
  • "purchase_order": "string",
  • "purchase_sequence": "string",
  • "notes": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter item do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir item do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Listar faturas do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

query Parameters
limit
integer

Quantidade de registros retornados pela busca

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

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

Criar fatura do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
number
required
string

Número do título

invoice_date
required
string
due_date
string
link
string <url>

Link de acesso a nota fiscal

notes
string

Observação do título

total
required
number

Valor total do título

paid
required
number

Valor pago do título

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "link": "string",
  • "notes": "string",
  • "total": 0,
  • "paid": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alterar fatura do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Request Body schema: application/json
number
required
string

Número do título

invoice_date
required
string
due_date
string
link
string <url>

Link de acesso a nota fiscal

notes
string

Observação do título

total
required
number

Valor total do título

paid
required
number

Valor pago do título

id
string <uuid>

Código único identificador

custom_id
string

Identificador único. Geralmente utilizado o código da sua aplicação

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "link": "string",
  • "notes": "string",
  • "total": 0,
  • "paid": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "custom_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter fatura do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Excluir fatura do documento

Authorizations:
BasicAuthBearerAuth
path Parameters
id
required
string <uuid>

Código único identificador

header Parameters
X-Tenant
required
string

Token identificador da empresa

Responses

}