Serviços

Listagem dos serviços disponibilizados pela api de integração do cake.

Tipos

Tipo	Descrição
Inteiro	Somente números inteiros até 11 dígitos
Decimal	Somente números, podendo conter casa decimais
Booleano	Somente números, aceitando apenas 0 (não, false) ou 1 (sim, true)
Texto	Alfanumérico de um tamnho específico
Data	Data no formato yyyy-mm-dd ex. 2016-01-01

* campos obrigatórios

Administradoras de Cartão

Url: /api/card_brand

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígito(s)
base_card_brand_id	Idenficador da :ref:Bandeira de cartão <bandeira_cartao>	Inteiro	11 dígito(s)
card_manager_id	Idenficador da :ref:Fornecedor <fornecedor>	Inteiro	11 dígito(s)

Bancos

Url: /api/bank

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígito(s)
base_bank *	Idenficador do Banco base	Inteiro	11 dígito(s)
name *	Nome do banco	Texto	255 posições
agency *	Agência	Inteiro	11 dígito(s)
account *	Conta	Inteiro	11 dígito(s)
boleto	Flag que indica se emite boleto	Booleano	1 dígito(s)
transferor_account	Conta do cedente	Inteiro	11 dígito(s)
wallet	Carteira padrão	Inteiro	11 dígito(s)
demonstrative	Mensagem impressa	Texto	4000 posições
instructions	Instruções	Texto	4000 posições
payment_days	Dias para o vencimento	Inteiro	11 dígito(s)
tax	Taxa do boleto	Decimal	20 dígito(s) e 2 decimais
accept_after_expiration	Aceita depois de vencido	Booleano	1 dígito(s)
document_species	Espécie de documento	Texto	3 posições
agreement	Convênio	Booleano	1 dígito(s)

Bancos Base

Url: /api/banks_base

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígito(s)
name	Nome do banco base	Texto	255 posições
number	Número do banco base	Inteiro	11 dígito(s)

Bandeiras de cartão

Url: /api/base_card_brand

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígito(s)
name	Nome da bandeira	Texto	255 posições

Bairros

Url: /api/district

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 posições
state	Identificador do estado	Inteiro	11 posições
city	Identificador da cidade	Inteiro	11 posições
name	Nome do bairro	Texto	255 posições

Base ICMS

Url: /api/base_icms

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código da base de ICMS	Texto	50 posições
name	Descrição da base de ICMS	Texto	255 posições

Base ICMSST

Url: /api/base_icmsst

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código da base de ICMS	Texto	50 posições
name	Descrição da base de ICMS	Texto	255 posições

Categoria de Fluxo de Caixa

Url: /api/cashflow_category

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígito(s)
name *	Nome da categoria	Texto	255 posições
dre_account	Identificador de conta DRE	Inteiro	11 dígito(s)
subaccounts	Identificador de subcontas	Inteiro	11 dígito(s)

Categoria de Operação Fiscal

Url: /api/fiscal_operation_category

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da categoria	Texto	255 posições

Categorias de Produtos

Url: /api/product_category

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da categoria	Texto	255 posições
symbol	Sigla da categoria	Texto	4 posições
markup	Markup da categoria	Decimal	20 dígitos e 4 decimais
code_cest	Código CEST da categoria	Texto	7 posições
tax_id	Referência ao identificador das tributações	Inteiro	11 dígitos
image	Nome da imagem da categoria	Texto	255 posições
external_code	Código externo da categoria	Texto	255 posições

Categorias de Serviços

Url: /api/service_category

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome	Texto	255 posições
tax_id	Referência ao identificador das tributações	Inteiro	11 dígitos

Centros de Custo

Url: /api/cost_center

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome do centro de custo	Texto	255 posições
active	Flag se está ativo	Booleano	1 dígito

CEP

Url: /api/zip_code

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
state	Identificador do estado	Inteiro	11 dígitos
city	Identificador da cidade	Inteiro	11 dígitos
district	Identificador do bairro	Inteiro	11 dígitos
zip_code	CEP	Texto	16 posições
street_name	Nome da rua	Texto	255 posições

CFOP

Url: /api/cfop

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código da cfop	Texto	50 posições
name	Nome da cfop	Texto	1000 posições

Cidades

Url: /api/city

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
state	Identificador do estado	Inteiro	11 dígitos
name	Nome da cidade	Texto	255 posições
zip_code	CEP da cidade	Texto	16 posições
cod_ibge	Código IBGE da cidade	Texto	7 posições

Clientes

Url: /api/customer

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
group	Identificador do grupo de clintes	Inteiro	11 dígitos
name *	Nome do cliente	Texto	255 posições
name_fantasy	Nome Fantasia do cliente	Texto	255 posições
person_type *	Tipo da pessoa	Texto	1 posição	F = Física J = Jurídica
doc_cnpj	Cnpj se for pessoa jurídica	Texto	14 posições
doc_ie	Inscrição estadual se tiver	Texto	100 posições
doc_im	Inscrição municipal	Texto	100 posições
doc_cpf	Cpf se for pessoa física	Texto	11 posições
contact_name	Nome para contato	Texto	255 posições
contact_email	Email de contato	Texto	255 posições
contact_phone	Telefone de contato	Texto	11 posições
contact_fax	Numero do fax	Texto	11 posições
contact_cellphone	Telefone Celular	Texto	11 posições
gender	sexo, “F” para feminino e “M” para masculino	Texto	1 posição
birthday	data de nascimento, formato “DD/MM/YYYY”	Data
address_street	Descrição da rua do endereço	Texto	255 posições
address_number	Número do endereço	Texto	10 posições
address_complement	Complemento do endereço	Texto	255 posições
address_district	Identificador do bairro ou descrição do bairro	Inteiro	11 dígitos
address_city	Identificador da cidade ou descrição da cidade	Inteiro	11 dígitos
address_state	Identificador do estado ou descrição do estado	Inteiro	11 dígitos
address_zip_code	Número do CEP	Inteiro	11 dígitos
observation	Observações do cliente	Texto	4000 posições
sales_order_obs	Observações para venda ao cliente	Texto	4000 posições
ind_ie_dest	Indicador de inscrição estadual do destinatário	Inteiro	1 dígito	1 = Contribuinte ICMS 2 = Contribuinte isento 9 = Não Contribuinte
ind_exterior	Flag para pessoa do exterior	Booleano	1 dígito
active	Flag se esta ativo	Booelano	1 dígito
address_country	Identificador para o pais	Inteiro	11 dígito
code	Código da pessoa	Texto	255 posições

Grupo de Clientes

Url: /api/customer_groups

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome do grupo de clientes	Texto	255 posições

Cofins

Url: /api/tax_cofins

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
scenario *	Identificador da tributação estados	Inteiro	11 dígitos
situation *	Identificador da situação COFINS	Inteiro	11 dígitos
aliquot	Aliquota	Decimal	20 dígitos e 2 decimais
fiscal_operation_id	Identificador da operação fiscal	Inteiro	11 dígitos
person_type	Tipo de Pessoa	Texto	1 posição	A = Ambas F = Física J = Jurídica

Comissões

Url: /api/seller_commission

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
seller *	Identificador do vendedor	Inteiro	11 dígitos
sales_order *	Identificador do pedido	Inteiro	11 dígitos
item_type *	Identificador do tipo de item	Inteiro	11 dígitos
product	Identificador do produto	Inteiro	11 dígitos
grid	Identificador da grade do produto	Inteiro	11 dígitos
line_feature	Identificador da característica de linha do produto	Inteiro	11 dígitos
column_feature	Identificador da característica de coluna do produto	Inteiro	11 dígitos
service	Identificador do serviço	Inteiro	11 dígitos
commission	Comissão	Decimal	20 dígitos e 2 decimais
item_price	Valor do item	Decimal	20 dígitos e 2 decimais
commission_total	Valor total da comissão	Decimal	20 dígitos e 2 decimais
commission_paid	Flag que indica se a comissão foi paga	Booleano	1 dígito
canceled	Flag que indica se a comissão foi cancelada	Booleano	1 dígito
day_to_pay	Data para pagamento	Data
day_billed	Data de pagamento	Data
description	Descrição da comissão	Texto
item_name	Descrição do item	Texto	255 posições
item_category_name	Descrição da categoria	Texto	255 posições
payment_day	Data do pagamento da comissão	Data

Condições das formas de pagamento

Url: /api/payment_form_condition

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
payment_form *	Identificador da forma de pagamento	Inteiro	11 dígitos
parcel *	Número de parcelas	Inteiro	11 dígitos
percentage *	Percentual de desconto	Decimal	20 dígitos e 2 decimais
percentage_discount *	Flag que indica se permite desconto	Booleano	1 dígito
days_parcel	Dias para a parcela	Inteiro	11 dígitos

Contas DRE

Url: /api/dre_account

Atributos:

Não permite inclusão/alteração/exclusão

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome da conta	Texto	20 posições
description	Descrição da conta	Texto	255 posições

Contas Financeiro

Url: /api/financial_account

Não permite inclusão/alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11
name	Nome da conta	Texto	255

Dados Empresa

Url: /api/company_data

Não permite inclusão/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
cnpj	CNPJ da empresa	Texto	14 posições
razao_social *	Razão social	Texto	255 posições
nome_fantasia *	Nome fantasia	Texto	255 posições
cnae_principal	Código da classificação nacional de atividades econômicas principal	Texto	255 posições
ie	Inscrição estadual	Texto	100 posições
im	Inscrição municipal	Texto	100 posições
fundacao	Data de fundação	Data
simples_nacional	Flag que indica se faz parte do simples nacional	Booleano
importer	Flag que indica se importa produtos	Booleano
address_street	Descrição da rua do endereço	Texto	255 posições
address_number	Número do endereço	Texto	10 posições
address_complement	Complemento do endereço	Texto	255 posições
address_district	Descrição do bairro	Texto	255 posições
address_city	Identificador da cidade ou descrição da cidade	Inteiro	11 dígitos
address_state	Identificador do estado ou descrição do estado	Inteiro	11 dígitos
address_zip_code	Identificador do cep ou numero do CEP	Inteiro	11 dígitos
phone	Número do telefone	Texto	9 posições
fax	Número do Fax	Texto	11 posições
email	Endereço de email	Texto	255 posições
contact_name	Nome do contato na empresa	Texto	255 posições
logo	Descrição do arquivo do logo	Texto	255 posições
color_scheme	schema de cores	Texto	255 posições
encouraging_cultural	Flag do fundo de cultura	Booleano
special_tax_regime	Regime tributário	Inteiro	6 dígitos

Devoluções

Url: /api/sales_return

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 digitos
sales_order_dev	Identificador do pedido devolvido	Inteiro	11 digitos
return_number *	Numéro da devolução	Inteiro	11 digitos
ecf_number	Número da impressora fiscal	Inteiro	11 digitos
note_number	Número da nota fiscal	Inteiro	11 digitos
note_series	Série da nota fiscal	Texto	10 posições
ccf_number	Contador do cupom fiscal	Inteiro	11 digitos
date_return *	Data da devolução	Data
date_received *	Data do recebimento	Data
seller	Identificador do verndedor	Inteiro	11 digitos
customer *	Identificador do cliente	Inteiro	11 digitos
resume	Resumo	Texto	4000 posições
subtotal	Subtotal	Decimal	20 dígitos e 2 decimais
discount_amount	Total de desconto	Decimal	20 dígitos e 2 decimais
discount_type	Tipo de desconto	Texto	1 posição	V = Valor P = Percentual
addition_amount	Total de acréscimo	Decimal	20 dígitos e 2 decimais
addition_canceled	Valor de acrécimo cancelado	Decimal	20 dígitos e 2 decimais
addition_type	Tipo de acrécimo	Texto	1 posição	V = Valor P = Percentual
total	Total	Decimal	20 dígitos e 2 decimais
addition_discount_order	Ordem de aplicação do desconto/acrécimo	Texto	1 posição	D = Primeiro foi aplicado desconto A = Pirmeiro foi aplicado acrescimo
payment_form	Identificador da forma de pagamento	Inteiro	11 dígitos
obs	Observações	Texto	4000 posições
validity *	Validade em dias	Inteiro	11 dígitos
shipping	Flag que indica se tem transporte	Booleano
shipping_transporter	Identificador da transportadora	Inteiro	11 dígitos
shipping_price	Valor do transporte	Decimal	20 dígitos e 2 decimais
invoice_model
canceled *	Flag que indica se está cancelado	Booleano
fiscal_operation	Identificador da :ref:´operação fiscal <operacoes_fiscais>´	Inteiro	11 dígitos
nfe *	Flag que indica se possui nota fiscal	Inteiro	11 dígitos
nfe_date	Data/hora da nota fiscal	DataHora
return_code	Código de retorno da nota fiscal	Inteiro	11 dígitos
nfe_key	Chave da nota fiscal	Texto	255 posições
nfe_status	Status da nota fiscal	Texto	255 posições
nfe_status_msg	Mensagem da nota fiscal	Texto	4000 posições
nfe_xmotivo		Texto	255 posições
nfe_nrec		Texto	255 posições
nfe_nprot		Texto	255 posições
nfe_danfe		Texto	255 posições
pdv_ini_dth	Data/hora do início da venda	DataHora
pdv_end_dth	Data/hora do final da venda	DataHora
change_total	Troco	Decimal	20 dígitos e 2 decimais
ecf_printer	Identificador da impressora fiscal	Inteiro	11 dígitos
other_expenses	Outras despesas	Decimal	20 dígitos e 2 decimais

Endereço de Entrega do Pedido

Url: /api/sales_orders_shipping_address

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_id	Identificador do pedido	Inteiro	11 dígitos
contact_name	Nome do contato para entrega	Texto	255 posições
contact_phone	Telefone de contato	Texto	11 posições
contact_cellphone	Celular de contato	Texto	11 posições
address_street	Rua do endereço	Texto	255 posições
address_number	Número do endereço	Texto	10 posições
address_complement	Complemento do endereço	Texto	255 posições
address_district	Bairro do endereço	Texto	255 posições
address_city	Identificador da cidade	Inteiro	11 dígitos
address_state	Identificador do estado	Inteiro	11 dígitos
address_zip_code	CEP do endereço	Texto	9 posições

Estados

Url: /api/state

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
country_iso	Código ISO do pais	Texto	2 posições
name	Nome do estado	Texto	255 posições
symbol	Sigla do estado	Texto	3 posições
uf_code	Código do estado	Texto	3 posições

Fluxo de Caixa

Url: /api/cashflow

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
cost_center	Identificador do centro de custo	Inteiro	11 dígitos
payment_form	Identificador da forma de pagamento	Inteiro	11 dígitos
registered_by	Identificador do usuário	Inteiro	11 dígitos
registered_date *	Data do registro	Data
incoming *	Flag se é entrada	Booleano
amount *	Total do lançamento	Decimal	20 dígitos e 2 decimais
description	Descrição do lançamento	Texto	255 posições
category	Identificador da categoria de fluxo de caixa	Inteiro	11 dígitos
due_date *	Data de Vencimento	Data
bank_account	Identificador do banco de origem	Inteiro	11 dígitos
bank_account_to	Identificador do banco de destino	Inteiro	11 dígitos
received *	Flag de recebido	Booleano
customer	Identificador do cliente	Inteiro	11 dígitos
customer_cpf_cnpj	CPF ou CNPJ dependendo do tipo de pessoa que o cliente for.	Texto	14 posições
ecf_printer	Identificador da impressora fiscal	Inteiro	11 posições
ecf_number	Número da impressora fiscal	Inteiro	11 posições
repeat	Tipo de repetição	Inteiro	11 posições
repeat_n	Quantidade de repetição	Inteiro	11 posições
amount_total	valor Total	Decimal	20 dígitos e decimais
penalty_for_delay	Multa por atraso	Decimal	20 dígitos e decimais
delay_interest	Juros	Decimal	20 dígitos e decimais
date_received	Data do recebimento/pagamento	Data
delay_interest_total	Juros totais	Decimal	20 dígitos e decimais
discount	Desconto	Decimal	20 dígitos e decimais
transporter	Identificador da transportadora	Inteiro	11 dígitos

Formas de Pagamento

Url: /api/payment_form

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome	Texto	255 posições
description	Descrição	Texto	255 posições
minimum_parcel	Valor mínimo de parcelas	Decimal	20 dígitos e 2 decimais
visible	Flag que indica se é visivel no sistema	Booleano
change_parcel_prices *	Flag que indica se permite alterar valor das parcelas	Booleano
change_only_first_parcel *	Flag que indica se permite alterar a primeira parcela	Booleano
visible_pdv	Flag que indica se permite visualizar no PDV	Booleano
name_pdv	Nome da forma de pagamento para a impressora fiscal	Texto	15 posições
bank_account	Identificador do banco	Inteiro	11 dígitos
uses_tef	Flag se usa TEF	Booleano
allow_change	Flag se permite troco	Booleano
payment_type	Nome do tipo base de pagamento	Texto	20 posições
delay_interest	Juros por atraso	Decimal	20 dígitos e 2 decimais
penalty_for_delay	Multa por atraso	Decimal	20 dígitos e 2 decimais
acknowledgement_of_a_debt	Reconhecimento de dívida	Texto	4000 posições
automatic_receipt	Recebimento automático	Booleano
automatic_payment	Pagamento automático	Booleano

Formas de Pagamento / Adminsitradora de cartão

Url: /api/payment_form_card_brand

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
payment_form_id *	Identificador da forma de pagamento	Inteiro	11 dígitos
card_brand_id	Identificador da administradora de cartão	Inteiro	11 dígitos

Fornecedores

Url: /api/supplier

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome do fornecedor	Texto	255 posições
person_type *	Tipo de pessoa	Texto	1 posições	F para física J para jurídica
doc_cnpj	CNPJ do fornecedor	Texto	14 posições
doc_ie	Inscrição estadual	Texto	100 posições
doc_im	Inscrição municipal	Texto	100 posições
doc_cpf	CPF do fornecedor	Texto	11 posições
contact_name	Nome de contato	Texto	255 posições
contact_email	Email	Texto	255 posições
contact_phone	Telefone	Texto	11 posições
contact_cellphone	Celular	Texto	11 posições
gender	Sexo	Texto	1 posições
birthday	Data de Nascimento	Data
address_street	Descrição da rua	Texto	255 posições
address_number	Número	Texto	10 posições
address_complement	Complemento	Texto	255 posições
address_district	Identificador do bairro ou descrição do bairro	Inteiro	11 dígitos
address_city	Identificador da cidade ou descrição da cidade	Inteiro	11 dígitos
address_state	Identificador do estado ou descrição do estado	Inteiro	11 dígitos
address_zip_code	Identificador do CEP ou número do CEP	Inteiro	11 dígitos
observation	Observações do fornecedor	Texto	4000 posições
fantasy_name	Nome Fantasia	Texto	255 posições
group	Identitificador do grupo de fornecedores	Inteiro	11 dígitos
min_purchase_value	Valor mínimo de compra	Decimal	20 dígitos e 2 decmais
ind_ie_dest	Indicador de inscrição estadual do destinatário	Inteiro	1 dígito
ind_exterior	Flag se é do exterior	Booleano
active	Flag se esta ativo	Booleano
address_country	Identificador do País	Inteiro	11 dígitos
code	Código do fornecedor	Texto	255 dígitos

Grades

Url: /api/grid

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da grade	Texto	255 posições
line_feature *	Identificador da característica de linha	Inteiro	11 dígitos
column_feature *	Identificador da característica de coluna	Inteiro	11 dígitos

Grades Características

Url: /api/grid_feature

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da característica	Texto	255 posições

Grades Características Valor

Url: /api/grid_detail

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da característica	Texto	255 posições
grid *	Identificador da grade	Inteiro	11 dígitos
feature *	Identificador da característica	Inteiro	11 dígitos
value *	Valor para a característica na grade	Texto	255 posições

ICMS

Url: /api/tax_icms

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
scenario *	Identificador da tributação estados	Inteiro	11 dígitos
situation *	Identificador da situação tributária do ICMS	Inteiro	11 dígitos
origin *	Identificador da origem do ICMS	Inteiro	11 dígitos
mod_bc_icms	Identificador da base do ICMS	Inteiro	11 dígitos
cfop *	Identificador da cfop	Inteiro	11 dígitos
mod_bc_icms_st	Identificador da base do ICMSST	Inteiro	11 dígitos
aliquot	Aliquota	Decimal	20 dígitos e 2 decimais
credit	Crédito	Decimal	20 dígitos e 2 decimais
aliquot_st	Aliquota de substituição	Decimal	20 dígitos e 2 decimais
credit_st	Crédito de substituição	Decimal	20 dígitos e 2 decimais
fiscal_operation_id	Operação fiscal	Inteiro	11 dígitos
code_deson	Código do motivo de desoneração de ICMS	Inteiro	1 dígito
icms_rate_interstate	Alíquota interestadual	Decimal	20 dígitos e 2 decimais
icms_rate_uf_dest	Alíquota no estado de destino	Decimal	20 dígitos e 2 decimais
icms_rate_fcp_uf_dest	Alóquota do fundo de combate a pobreza no estado de destino	Decimal	20 dígitos e 2 decimais
mva_rate_st	Valor do MVA	Decimal	20 dígitos e 2 decimais
person_type	Tipo de pessoa	Texto	1 posição	F = Física J = Jurídica A = Ambas

Impressoras Fiscais

Url: /api/ecf_printer

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
ecf_number *	Número da impressora	Inteiro	11 dígitos
ecf_serial *	Serial da impressora	Texto	20 posições
ecf_type	Tipo da impressora	Texto	7 posições
ecf_brand	Marca da impressora	Texto	20 posições
ecf_model	Modelo da impressora	Texto	20 posições
ecf_version	Versão da impressora	Texto	10 posições
instalation_date	Data de instalação	DataHora
cro_number	Contador de reinicio de operações	Inteiro	11 dígitos
mf_adicional	Memória fiscal adicional	Texto	1 posições
datetime_sb		DataHora
substitutions_owner		Texto	4 posições

Informações Nota Fiscal

Url: /api/tax_nfinfo

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 digitos
scenario *	Identificador da tributação estados	Inteiro	11 digitos
info *	Informações	Texto	4000 posições
fiscal_operation_id	Identificador da operação fiscal	Inteiro	11 digitos
person_type	Tipo de pessoa	Texto	1 posição	F = Física J = Jurídica A = Ambas

IPI

Url: /api/tax_ipi

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
scenario *	Identificador da tributação estados	Inteiro	11 dígitos
situation *	Identificador da situação tributário de IPI	Inteiro	11 dígitos
aliquot	Aliquota	Decimal	20 dígitos e 2 decimais
code	Código do IPI	Texto	255 posições
fiscal_operation_id	Identificador da operação fiscal	Inteiro	11 dígitos
code_enq	Código de enquadramento	Texto	20 posições
person_type	Tipo de pessoa	Texto	1 posição	F = Física J = Jurídica A = Ambas

Itens do Pedidos

Url: /api/sales_order_item

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_id	Identificar do pedido	Inteiro	11 dígitos
seller_id	Identificar do vendedor	Inteiro	11 dígitos
product_id	Identificar do produto	Inteiro	11 dígitos
grid	Identificar da grade	Inteiro	11 dígitos
line_feature	Identificar do valor da característica de linha	Inteiro	11 dígitos
column_feature	Identificar do valor da característica de coluna	Inteiro	11 dígitos
service_id	Identificar do serviço	Inteiro	11 dígitos
item_name *	Nome do item	Texto	255 posições
item_add_info	Informações adicionais do item	Texto	255 posições
item_type	Identificador do tipo do item	Inteiro	11 dígitos
item_number	Número	Inteiro	11 dígitos
qtd	Quantidade	Decimal	20 dígitos e 2 decimais
price_sell *	Preço de venda	Decimal	20 dígitos e 2 decimais
price_cost *	Preço de custo	Decimal	20 dígitos e 2 decimais
discount_amount	Total de desconto	Decimal	20 dígitos e 2 decimais
discount_type	Tipo de desconto	Texto	1 posição	V = Valor P = Percentual
discount_percent	Valor do percentual de desconto	Decimal	20 dígitos e 2 decimais
addition_amount	Total de acréscimo	Decimal	20 dígitos e 2 decimais
addition_type	Tipo de acréscimo	Texto	1 posição	V = Valor P = Percentual
addition_percent	Valor do percentual de acréscimo	Decimal	20 dígitos e 2 decimais
total	Valor total	Decimal	20 dígitos e 2 decimais
canceled *	Flag que indica se está cancelado	Booleano
qtd_canceled	Quantidade cancelada	Decimal	20 dígitos e 2 decimais
canceled_amount	Valor de desconto cancelado	Decimal	20 dígitos e 2 decimais
round_type	Tipo de arrendondamento	Texto	1 posição	A = Arredondado T = Truncado
discount_coupon_prorated	Desconto rateado no cupom	Decimal	20 dígitos e 2 decimais
addition_coupon_prorated	Acréscimo rateado no cupom	Decimal	20 dígitos e 2 decimais
price_taxable	Valor tributavel	Decimal	20 dígitos e 2 decimais
shipping_coupon_prorated	Transporte rateado	Decimal	20 dígitos e 2 decimais
expense_coupon_prorated	Despesas rateadas	Decimal	20 dígitos e 2 decimais

Itens da Ordem de Compra

Url: /api/purchase_order_item

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
purchase_order_id	Identificador da ordem de compra	Inteiro	11 dígitos
product_id	Identificador do produto	Inteiro	11 dígitos
grid	Identificador da grade do produto	Inteiro	11 dígitos
line_feature	Identificador do valor da caracteristica de linha	Inteiro	11 dígitos
column_feature	Identificador do valor da caracteristica de coluna	Inteiro	11 dígitos
service_id	Identificador do serviço	Inteiro	11 dígitos
item_type	Identificador do tipo do item	Inteiro	11 dígitos
item_name	Nome do item	Texto	255 posições
qtd	Quantidade solicitada	Decimal	20 dígitos e 4 decimais
qtd_served *	Quantidade entregue	Decimal	20 dígitos e 4 decimais
unit_price *	Preço unitário	Decimal	20 dígitos e 2 decimais
ncm	NCM do produto	Inteiro	11 dígitos
cst	CST do produto	Inteiro	11 dígitos
price_served	Preço no recebimento	Decimal	20 dígitos e 2 decimais

Locais de Estoque

Url: /api/stock_locale

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
locale_name *	Nome do local	Texto	255 posições
active *	Indicador de ativo	Booleano

Items do Local de Estoque

Url: /api/stock_locale_items

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
stock_locale_id *	Identificador do local de estoque	Inteiro	11 dígitos
product_id *	Identificador do produto	Inteiro	11 dígitos
stock *	Estoque do produto	Decimal	20 dígitos e 2 decimais

Items de grade do Local de Estoque

Url: /api/stock_locale_items_grid

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
stock_locale_id *	Identificador do local de estoque	Inteiro	11 dígitos
product_id *	Identificador do produto de grade	Inteiro	11 dígitos
stock *	Estoque do produto	Decimal	20 dígitos e 2 decimais

Marcas

Url: /api/brand

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da marca	Texto	255 posições

Modelos Fiscais

Url: /api/fiscal_models

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
model *	Modelo	Texto	10 posições
name *	Nome do modelo	Texto	255 posições
serie *	Série	Texto	10 posições
serie_for_selling	Série para vendas	Texto	3 posições
manual_numbering	Flag se utiliza numeração manual	Booleano
current_number	Número atual	Inteiro	11 dígitos
id_token	Identificador do token	Texto	6 posições
number_token	Número do token	Texto	50 posições

Movimentos do PDV

Url: /api/pdv_movements

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
operator	Operador do PDV	Inteiro	11 posições
ecf_printer	Identificador do Impressora Fiscal	Inteiro	11 posições
ecf_number	Número da impressora fiscal	Inteiro	11 posições
date	Data do movimento	Data
coo_number	Contador de operação da impressora fiscal	Inteiro	11 posições
ccf_number	Contador de cupons fiscais da impressora fiscal	Inteiro	11 posições
gnf_number	Contador de operaração não fiscal da impressora fiscal	Inteiro	11 posições
operation *	Identificação da operação	Texto	255 posições	Abertura Suprimento Sangria Sobra Falta Venda NaoFiscal Fechamento
payment_form *	Identificador de Formas da Pagamento	Inteiro	11 posições
amount *	Valor total do movimento	Decimal	20 dígitos e 2 decimais
type *	Tipo do movimento	Texto	1 posição	E = Entrada S = Saída
canceled *	Indicador de cancelado	Inteiro	1 posição
discount *	Valor de desconto do movimento	Decimal	20 dígitos 2 decimais
addition *	Valor de acréscimo do movimento	Decimal	20 dígitos 2 decimais
change	Valor de troco do movimento	Decimal	20 dígitos 2 decimais
parcels	Quantidade de parcelas	Inteiro	11 posições
registration_date	Data e hora de registro	DataHora
identification_tef	Identificação do TEF	Texto	10 posições
control_number_tef	Número de controle do TEF	Texto	30 posições
network_tef	Rede do TEF	Texto	8 posições
transaction_tef	Transação do TEF	Texto	2 posições
nsu_tef	NSU do TEF	Texto	12 posições
authorization_tef	Autorização do TEF	Texto	6 posições
financing_tef	Indicador de parcelamento do TEF	Inteiro	1 posição
parcels_tef	Quantidade de parcelas do TEF	Inteiro	2 posições
customer_voucher_tef	Voucher impresso do cliente no TEF	Texto	4000 posições
company_voucher_tef	Voucher impresso da empresa no TEF	Texto	4000 posições
date_voucher_tef	Data da impressão do TEF	Inteiro	8 posições
time_voucher_tef	Hora da impressão do TEF	Inteiro	6 posições
voucher_printed_tef	Indicador se foi impresso o voucher do TEF	Inteiro	1 posição
customer_voucher_tef_canc	Voucher de cancelamento impresso para o cliente no TEF	Texto	4000 posições
company_voucher_tef_canc	Voucher de cancelamento impresso para a empresa no TEF	Texto	4000 posições
identification_tef_canc	Identificação de cancelamento do TEF	Texto	10 posições
control_number_tef_canc	Número de controle de cancelamento do TEF	Texto	30 posições
tef_status	Status do movimento no TEF	Inteiro	1 posição	1 = Aprovada 0 = Pendente
tef_nsu_host	NSU host do TEF	Texto	20 posições
card_brand_id	Identificador de Bandeira de cartão	Inteiro	11 posições

NCM

Url: /api/ncm

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
ncm	Código NCM	Texto	8 posições
name	Nome do NCM	Texto	100 posições

Operações Fiscais

Url: /api/fiscal_operation

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da operação fiscal	Texto	255 posições
operation *	Identificador do tipo da operação	Inteiro	11 dígitos
type	Tipo da operação	Texto	1 posição	E entrada S saída
sender_receiver	Tipo de destinatário	Texto	1 posição	S = Supplier C - Customer
financial_account *	Centro de custo	Inteiro	11 dígitos
change_stock	Indicador de altera estoque	Texto	3 posições	0 = Não Altera 1 = Entrada 2 = Saída

Ordens de Compra

Url: /api/purchase_order

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
supplier	Identificador do fornecedor	Inteiro	11 dígitos
date_order *	Data da ordem de compra	Data
discount_amount	Total de desconto	Decimal	20 dígitos e 2 decimais
total	Valor Total	Decimal	20 dígitos e 2 decimais
payment_form	Identificador da forma de pagamento	Inteiro	11 dígitos
qtd_parcels	Número de parcelas	Inteiro	11 dígitos
obs	Observações	Texto	4000 posições
tip_status	Status da ordem de compra	Inteiro	11 dígitos	1 = Em abrto 2 = Recebida Parcialmente 3 = Recebida
fiscal_operation	Identificador da operação fiscal	Inteiro	11 dígitos
nf	Número da nota fiscal	Inteiro	11 dígitos
serie	Série da nota fiscal	Texto	7 posições
date_emis_nf	Data da emissão da nota fiscal	Data
shipping_transporter	Identificação da transportadora	Inteiro	11 dígitos
shipping_value	Valor do transporte	Decimal	20 dígitos e 2 decimais
icms_st	Valor de ICMS de substituição	Decimal	20 dígitos e 2 decimais
pis	Valor de pis	Decimal	20 dígitos e 2 decimais
cofins	Valor de cofins	Decimal	20 dígitos e 2 decimais
addition_amount	Acréscimo	Decimal	20 dígitos e 2 decimais

Origens Tributação

Url: /api/tax_origin

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome da origem	Texto	255 posições
code	Código da origem	Texto	20 posições

Grupo de Parcelas do Pedido

Url: /api/sales_order_parcel_group

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_id	Identificador do Pedido	Inteiro	11 dígitos
price	Valor pago na forma de pagamento	Decimal	20 dígitos e 2 decimais
payment_form	Identificador Forms de pagamento	Inteiro	11 dígitos
total_discount	Total de desconto da forma de pagamento	Decimal	20 dígitos e 2 decimais
total_addition	Total de acréscimo da forma de pagamento	Decimal	20 dígitos e 2 decimais
change	Troco da forma de pagamento	Decimal	20 dígitos e 2 decimais

Parcelas do Pedido

Url: /api/sales_order_parcel

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_id	Identificado do pedido	Inteiro	11 dígitos
parcel *	Número da parcela	Inteiro	11 dígitos
expiration *	Data da expiração	Data
price *	Valor da parcela	Decimal	20 dígitos e 2 decimais
payment_form	Identificador Forma de pagamento	Inteiro	11 dígitos
sales_parcel_group	Identificador Grupo de parcelas	Inteiro	11 dígitos

Parcelas da Ordem de Compra

Url: /api/purchase_order_parcel

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
purchase_order_id	Identificador da ordem de compra	Inteiro	11 dígitos
parcela *	Número da parcela	Inteiro	11 dígitos
vencimento *	Data de vencimento	Data
value *	Valor da parcela	Decimal	20 dígitos e 2 decimais

Pedidos

Url: /api/sales_order

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
order_number *	Número do pedido	Inteiro	11 dígitos
order_type *	Tipo do pedido	Inteiro	11 dígitos	0 = Orcamento 1 = Venda 2 = Faturado 3 = Cupom Fiscal 4 = Devolução 5 = Devolucao de Compra 6 = Transferência 7 = Venda Futura 8 = NFSe
environment_order	Flag se é pedido por ambiente	Booelano
ecf_number	Número da impressora fiscal <impressoras_fiscais>	Inteiro	11 dígitos
note_number	Número da nota	Inteiro	11 dígitos
note_series	Série da nota	Texto	10 posições
ccf_number	Contador do cupom fiscal	Inteiro	11 dígitos
delivery_time *	Tempo da compra	Data
date_order *	Data do pedido	Data
date_sell	Data da venda	Data
date_billed	Data do Faturamento	Data
emission_date	Data da emissão	DataHora
supllier	Identificador do fornecedr	Inteiro	11 dígitos
seller	Identificador do vendedor	Inteiro	11 dígitos
customer *	Identificador do cliente	Inteiro	11 dígitos
resume		Texto	4000 posições
price_list	Identificador da lista de preços	Inteiro	11 dígitos
subtotal	Subtotal do pedido	Decimal	20 dígitos e 2 decimais
discount_amount	Total de desconto	Decimal	20 dígitos e 2 decimais
discount_type	Tipo de desconto	Texto	1 posição	V = Valor P = Percentual
discount_percent	Valor percentual do desconto	Decimal	20 dígitos e 2 decimais
addition_amount	Total de acréscimo	Decimal	20 dígitos e 2 decimais
addition_canceled	Acréscimo cancelado	Decimal	20 dígitos e 2 decimais
addition_type	Tipo de acréscimo	Texto	1 posição	V = Valor P = Percentual
addition_percent	Valor percentual do acréscimo	Decimal	20 dígitos e 2 decimais
total	Valor total	Decimal	20 dígitos e 2 decimais
addition_discount_order	Ordem de aplicação do desconto e acréscimo	Texto	1 posição	D = Primeiro foi aplicado desconto A = Pirmeiro foi aplicado acrescimo
payment_form	Forma de pagamento	Inteiro	11 dígitos
obs	Observações	Texto	4000 posições
validity *	Validade em dias	Inteiro	11 dígitos
shipping	Flag que indica se tem transporte	Booleano
shipping_transporter	Identificador da transportadora	Inteiro	11 dígitos
shipping_price	valor do transporte	Decimal	20 dígitos e 2 decimais
invoice_model	Modelo da nota	Texto	3 posições
canceled *	Flag que indica se esta cancelado	Booleano
inutilized *	Flag que indica se está inutilizado	Booleano
fiscal_operation	Identificador da operação fiscal	Inteiro	11 dígitos
nfe *	Flag que identifica se tem nota fiscal emitida	Booleano
nfe_date	Data da nota fiscal	Data
return_code	Código de retorno da nota fiscal	Inteiro	11 dígitos
nfe_key	Chave da nota fiscal	Texto	255 posições
nfe_status	Status da nota fiscal	Texto	255 posições
nfe_status_msg	Mensagem da nota fiscal	Texto	4000 posições
nfe_xmotivo	Motivo da nota fiscal	Texto	255 posições
nfe_nrec	Número de retorno	Texto	255 posições
nfe_nprot	Número do protocolo	Texto	400 posições
nfe_danfe	Nome do arquivo da danfe	Texto	255 posições
pdv_ini_dth	Data / Hora inicial do cupom no PDV	DataHora
pdv_end_dth	Data / Hora final do cupom no PDV	DataHora
change_total	Valor do troco	Decimal	20 dígitos e 2 decimais
customer_cpf_cnpj	CPF ou CNPJ do cliente	Texto	14 posições
ecf_printer	Identificador da impressora fiscal	Inteiro	11 dígitos
indPag	Tipo de pagamento, usado somente para NFe	Inteiro	11 dígitos
shipping_quantity	Quntidade de volumes para transporte	Inteiro	11 dígitos
shipping_gross_weight	Peso bruto de transporte	Decimal	20 dígitos e 3 decimais
shipping_net_weight	Peso líquido para transporte	Decimal	20 dígitos e 3 decimais
shipping_species	Tipo de transporte	Texto	255 posições
shipping_brand		Texto	255 posições
shipping_numeration		Texto	255 posições
nfe_key_code	Còdigo da chave de NFe	Texto	8 posições
nfe_key_dv		Inteiro	11 dígitos
nfe_verified		Booleana
nfe_id		Texto	50 posições
sales_return_id	Identificador do pedido de devolução	Inteiro	11 posições
supplier_label	Descrição do fornecedor	Texto	255 posições
external_sale_number	Número externo da venda	Texto	255 posições
sales_order_ref	Venda Referenciada	Inteiro	11 posições
delivered_order	Venda somente de entrega, venda futura com entrega posterior	Booleano
ecommerce_id	Identificador do ecommerce integrado	Inteiro	11 posições
other_expenses	Outras despesas	Decimal	20 dígitos e 2 decimais
contact_name	Nome de contato	Texto	255 posiçoes
internal_obs	Observações internas do pedido	Texto	4000 posiçoes

PIS

Url: /api/tax_pis

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
scenario *	Identificador da tributação estados	Inteiro	11 dígitos
situation *	Identificador da situação tributário de PIS	Inteiro	11 dígitos
aliquot	Aliquota	Decimal	20 dígitos e 2 decimais
fiscal_operation_id	Identificador da operação fiscal	Inteiro	11 dígitos
person_type	Tipo de pessoa	Texto	1 posição

Produtos

Url: /api/product

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
category	Identificador da categoria do produto	Inteiro	11 dígitos
supplier	Identificador do fornecedor	Inteiro	11 dígitos
name *	Nome do produto	Texto	255 posições
code	Codigo do produto	Texto	255 posições
price_sell	Preço de Venda	Decimal	20 dígitos e 2 decimais
price_cost	Preço de custo	Decimal	20 dígitos e 2 decimais
price_purchase	Preço de compra	Decimal	20 dígitos e 2 decimais
stock	Estoque	Decimal	20 dígitos e 4 decimais
barcode_ean	Código de barras EAN	Texto	255 posições
measure_unit	Identificador da unidade de medida	Inteiro	11 dígitos
brand	Identificador da marca do produto	Inteiro	11 dígitos
ncm	Identificador do NCM do produto	Inteiro	11 dígitos
net_weight	Peso líquido do produto	Decimal	20 dígitos e 4 decimais
gross_weight	Peso bruto do produto	Decimal	20 dígitos e 4 decimais
grid	Identificador da grade	Inteiro	11 dígitos
tax_purchase_id	Identificador da tributação de compra	Inteiro	11 dígitos
tax_sale_id	Identificador da tributação de venda	Inteiro	11 dígitos
tax_warranty_id	Identificador da tributação de garantia	Inteiro	11 dígitos
tax_devolution_id	Identificador da tributação de devolução	Inteiro	11 dígitos
code_number	Código do produto	Inteiro	11 dígitos
round_type	Tipo de arredondamento	Texto	1 posição	A = Arredondado T = Truncado
production_type	Tipo de produção	Texto	1 posição	P = Proprio T = Terceiro
active	Flag de ativo	Booleano
image	Nome da imagem do produto	Texto	255 posições
markup	Markup do produto	Decimal	20 dígitos e 4 decimais
technical_specifications	Especificações Técnicas	Texto	4000 posições
observation	Observações	Texto	4000 posições
model	Modelo	Texto	100 posições
icms	Percentual de ICMS de compra	Decimal	20 dígitos e 2 decimais
icms_st	Percentual de ICMSST de compra	Decimal	20 dígitos e 2 decimais
ipi	Percentual de IPI de compra	Decimal	20 dígitos e 2 decimais
shipping	Percentual de frete de compra	Decimal	20 dígitos e 2 decimais
minimum_stock	Estoque Mínimo	Decimal	20 dígitos e 4 decimais
maximum_stock	Estoque Máximo	Decimal	20 dígitos e 4 decimais
tax_id	Identificador da tributação	Inteiro	11 dígitos
youtube_code	Código do youtube	Texto	100 posições
ind_ecommerce	Flag de integração com e-commerce	Inteiro	1 posição
product_type	Tipo do Produto	Inteiro		1 = Produto Pronto 2 = Produto Produzido 3 = Produto para produção
down_stock	Flag de movimenta estoque	Booleano
supplier_ref_code	Código de referência do fornecedor	Texto	255 posições
code_cest	Código CEST	Texto	7 posições
code_isbn	Código ISBN	Inteiro	11 dígitos
weight_with_package	Peso com Embalagem	Decimal	20 dígitos e 4 decimais
height	Altura	Decimal	20 dígitos e 4 decimais
height_with_package	Altura com embalagem	Decimal	20 dígitos e 4 decimais
width	Largura	Decimal	20 dígitos e 4 decimais
width_with_package	Largura com embalagem	Decimal	20 dígitos e 4 decimais
depth	Profundidade	Decimal	20 dígitos e 4 decimais
depth_with_package	Profundidade com embalagem	Decimal	20 dígitos e 4 decimais
loss	Perda do produto	Decimal	20 dígitos e 2 decimais
production_observation	Observação de produção	Texto	4000 posições
localization	Localização do produto no estoque	Texto	255 posições
collection	Identificador da Coleçao	Inteiro	11 dígitos
price_promo	Preço promocional	Decimal	20 dígitos e 2 decimais
use_grid	Flag de produto de grade	Booleano
creation_time	Data e hora de criação do produto	Inteiro	11 dígitos
update_time	Data e hora de alteração do produto	Inteiro	11 dígitos

Produtos Grade

Url: /api/product_grid

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome do produto na grade	Texto	255 posições
reference_product *	Identificador do produto que utiliza a grade	Inteiro	11 dígitos
grid *	Identificador da grade que originou o produto	Inteiro	11 dígitos
line_feature *	Identificador do valor da característica de linha	Inteiro	11 dígitos
column_feature *	Identificador do valor da característica de coluna	Inteiro	11 dígitos
price_sell	Preço de Venda	Decimal	20 dígitos e 2 decimais
price_cost	Preço de Custo	Decimal	20 dígitos e 2 decimais
stock	Estoque	Decimal	20 dígitos e 4 decimais
barcode_ean	Código de barras EAN	Texto	255 posições
active	Flag se está ativo	Booleano
minimum_stock	Estoque mínimo	Decimal	20 dígitos e 4 decimais
maximum_stock	Estoque Máximo	Decimal	20 dígitos e 4 decimais
line_feature_symbol	Sigla da característica de linha	Texto	255 posições
column_feature_symbol	Sigla da característica de coluna	Texto	255 posições
sku	SKU do item	Texto	255 posições
grid_model	Identificador da grade modelo	Inteiro	11 dígitos
line_feature_value	Descrição da característica de linha	Texto	255 posições
column_feature_value	Descrição da característica de coluna	Texto	255 posições
creation_time	Data/hora da criação do registro	DataHora
update_time	Data/hora da atualização do registro	DataHora

Propostas Comerciais

Url: /api/commercial_proposal

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_id	Identificador do pedido	Inteiro	11 dígitos
created	Data/hora de criação	DataHora
data	Data da proposta	Data
data_hash	Hash da proposta	Texto	32 posições

Recebimento Ordem de Compra

Url: /api/purchase_order_receives

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
purchase_order_id	Identificador da ordem de compra	Inteiro	11 dígitos
nf	Número da nota fiscal	Inteiro	11 dígitos
serie	Série da nota fiscal	Texto	7 posições
nfe_key	Chave da nota fiscal	Texto	50 posições
date_emis_nf	Data da emissão da nota fiscal	Data
product_id	Identificador do pedido	Inteiro	11 dígitos
qtd	Quantidade solicitada	Decimal	20 dígitos e 4 decimais
qtd_served *	Quantidade entregue	Decimal	20 dígitos e 4 decimais
date_receive	Data do recebimento	Data
price_served	Preço da entrega	Decimal	20 dígitos e 2 decimais
price_cost	Preço de custo	Decimal	20 dígitos e 2 decimais
supplier	Identificador do fornecedor	Inteiro	11 dígitos
reversed	Indicador se foi revertida	Booleano

Relacionamento de fluxo de caixa

Url: /api/cashflow_relationship

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
cashflow	Identificador de fluxo de caixa	Inteiro	11 dígitos
relationship	Id do registro relacionado no campo where	Inteiro	11 dígitos
where	Informação do tipo de relacionamento	Texto	255 dígitos	PurchaseOrder.id = Ordem de compra SalesOrder.id = Venda PurchaseOrderReceives.id = Recebimnto de compra SalesOrderParcel.id = Parcela da venda CashFlow.id = Fluxo de caixa PurchaseReturnParcel.id = Parcela de devolução de compra PDVMovements.id = Movimento de PDV SellerCommission.id = Comissão de Vendedor PurchaseOrderReceivesCTE.id = Rececebimento de CTE PurchaseReturn.id = Devolução de compra SalesReturn.id = Devolução de venda CashFlowTransfer.id = Transaferência de fluxo de caixa AppClosingDetail.id = Detalhamento de fechamento de caixa

Serviços

Url: /api/service

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
category	Identificador da categoria do serviço	Inteiro	11 dígitos
name *	Nome	Texto	255 posições
price_sell	Valor de venda	Decimal	20 dígitos e 2 decimais
cost	Custo	Decimal	20 dígitos e 2 decimais
code	Código	Texto	255 posições
nbs	Nomenclatura Brasileira de Serviços	Texto	255 posições
round_type	Tipo de arredondamento	Texto	1 posição	A = Arredondado T = Truncado
production_type	Tipo de produção	Texto	1 posição	P = Próprio T = Terceiro
measure_unit	Identificador da unidade de medida	Inteiro	11 dígitos
tax_code	Identificador das tributações	Inteiro	11 dígitos
additional_description	Descrição Adicional	Texto	255 posições

Situações ICMS

Url: /api/icms_situation

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código da situação	Texto	20 posições
name	Nome da Situação	Texto	255 posições
has_aliquot	Flag se possui aliquota	Booleano
has_replacement	Flag se possui substituição	Booleano
has_credit	Flag se gera crédito	Booleano
has_credit_st	Flag se gera crédito de substitução	Booleano

Situações IPI

Url: /api/ipi_situation

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código da situação	Texto	20 posições
name	Nome da Situação	Texto	255 posições

Situações PIS/COFINS

Url: /api/pis_cofins_situation

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código da situação	Texto	20 posições
name	Nome da Situação	Texto	255 posições

Taxas de cartão de crédito

Url: /api/payment_form_card_brand_tax

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
days_receive	Dias para recebimento	Inteiro	11 dígitos
parcel_start	Parcela de início	Inteiro	11 dígitos
parcel_end	Parcela final	Inteiro	11 dígitos
payment_form_card_brand_id	Identificador do Formas de pagamento / ADM Cartão	Inteiro	11 dígitos
tax_percent	Valor percentual de taxa	Decimal	20 dígitos e 2 decimais
tax_value	Valor da taxa	Decimal	20 dígitos e 2 decimais

Tipo de Ajuste de Estoque

Url: /api/adjustement_type

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome do tipo de ajuste	Texto	50 posições

Ajustes de Estoque

Url: /api/stock_adjustment

Não permite Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
product	Identificador do produto	Inteiro	11 dígitos
grid	Identificador da Grade	Inteiro	11 dígitos
line_feature	Identificador da característica de linha	Inteiro	11 dígitos
column_feature	Identificador da característica de coluna	Inteiro	11 dígitos
date	Data do ajuste	Data
quantity	Quantidade	Decimal	20 dígitos e 4 decimais
type	Identificador do Tipos de Ajustes	Texto	50 posições
locale_id	Identificador do local de estoque	Inteiro	11 dígitos

Tipos de Item

Url: /api/item_type

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome do tipo de item	Texto	20 posições

Tipo de Operação Fiscal

Url: /api/fiscal_operation_type

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome do tipo de operação fiscal	Texto	255 posições

Tipos de Usuário

Url: /api/user_type

Não permite inclusão/Alteração/exclusão

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome do tipo de usuário	Texto	255 posições
available	Flag que indica se está disponível	Booleano

Transportadoras

Url: /api/transporter

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da transportadora	Texto	255 posições
icms_free	Livre de ICMS	Booleano
antt_register		Texto	255 posições
doc_cnpj	CNPJ	Texto	14 posições
doc_ie	Inscricao estadual	Texto	100 posições
doc_im	Inscricao municipal	Texto	100 posições
contact_name	Nome para contato	Texto	255 posições
contact_email	Endereço de email	Texto	255 posições
contact_phone	Telefone de contato	Texto	11 posições
contact_cellphone	Celular de contato	Texto	11 posições
address_street	Descrição da rua do endereço	Texto	255 posições
address_number	Número do endereço	Texto	10 posições
address_complement	Complemento do endereço	Texto	255 posições
address_district	Identificador do bairro ou descrição do bairro	Inteiro	11 dígitos
address_city	Identificador da cidade ou descrição da cidade	Inteiro	11 dígitos
address_state	Identificador do estado ou descrição do estado	Inteiro	11 dígitos
address_zip_code	Identificador do CEP ou número do CEP	Inteiro	11 dígitos

Tributações

Url: /api/tax

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da tributação	Texto	255 posições
type	1 para produto e 2 para serviço	Texto	20 posições

Tributações Estados

Url: /api/tax_state

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
tax *	Identificador da tributação	Inteiro	11 dígitos
state_from *	Identificador do estado de origem	Inteiro	11 dígitos
state_to *	Identificador do estado de destino	Inteiro	11 dígitos

Tributações dos itens do pedido

Url: /api/sales_order_item_tax

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_id *	Identificador do pedido	Inteiro	11 dígitos
sales_order_item_id *	Identificador do item do pedido	Inteiro	11 dígitos
cfop	Identificador da cfop	Inteiro	11 dígitos
fiscal_operation_id	Identificador da operação fiscal	Inteiro	11 dígitos
cst	CST	Texto	3 posições
ibpt_aliquot	Aliquota segundo IBPT	Decimal	20 dígitos e 2 decimais
ibpt_amount	Valor total segundo o IBPT	Decimal	20 dígitos e 2 decimais
icms_rate	Aliquota de ICMS	Decimal	20 dígitos e 2 decimais
icms_totalizer	Totalizador do icms, utilizado apenas no PDV	Texto	7 posições
icms_basis	Base do ICMS	Decimal	20 dígitos e 2 decimais
icms_amount	ICMS Total	Decimal	20 dígitos e 2 decimais
icms_discount	Desconto do ICMS	Decimal	20 dígitos e 2 decimais
icms_addition	Acréscimo do ICMS	Decimal	20 dígitos e 2 decimais
icms_canceled	ICMS cancelado, utilizado apenas no PDV	Decimal	20 dígitos e 2 decimais
icms_st	Situação tributário do ICMSST	Decimal	20 dígitos e 2 decimais
icms_not_incident	ICMS não incidente	Decimal	20 dígitos e 2 decimais
icms_free	Livre de ICMS	Decimal	20 dígitos e 2 decimais
issqn_rate	Taxa ISSQN	Decimal	20 dígitos e 2 decimais
issqn_totalizer	Totalizador ISSQN utilizado apenas no PDV	Texto	7 posições
issqn_basis	Base do ISSQN	Decimal	20 dígitos e 2 decimais
issqn_amount	Valor total do ISSQN	Decimal	20 dígitos e 2 decimais
issqn_discount	Desconto do ISSQN	Decimal	20 dígitos e 2 decimais
issqn_addition	Acréscimo do ISSQN	Decimal	20 dígitos e 2 decimais
issqn_canceled	ISSQN cancelado, utilizado apenas no PDV	Decimal	20 dígitos e 2 decimais
issqn_st	ISSQN de substituição	Decimal	20 dígitos e 2 decimais
issqn_not_incident	ISSQN não incidente	Decimal	20 dígitos e 2 decimais
issqn_free	Livre de ISSQN	Decimal	20 dígitos e 2 decimais
ipi_rate	Taxa de IPI	Decimal	20 dígitos e 2 decimais
ipi_amount	Total de IPI	Decimal	20 dígitos e 2 decimais
ipi_cst	Cst do IPI	Texto	3 posições
pis_rate	Taxa do PIS	Decimal	20 dígitos e 2 decimais
pis_amount	Total de PIS	Decimal	20 dígitos e 2 decimais
pis_cst	Cst do PIS	Texto	3 posições
cofins_rate	Taxa de COFINS	Decimal	20 dígitos e 2 decimais
cofins_amount	Total de COFINS	Decimal	20 dígitos e 2 decimais
cofins_cst	Cst do COFINS	Texto	3 posições
inss_rate	Taxa de INSS	Decimal	20 dígitos e 2 decimais
inss_amount	Total de INSS	Decimal	20 dígitos e 2 decimais
irrf_rate	Taxa de IRRF	Decimal	20 dígitos e 2 decimais
irrf_amount	Total de IRRF	Decimal	20 dígitos e 2 decimais
csll_rate	Taxa de CSLL	Decimal	20 dígitos e 2 decimais
csll_amount	Total de CSLL	Decimal	20 dígitos e 2 decimais
other_taxes	Outras taxas	Decimal	20 dígitos e 2 decimais
nfe_info	Informação nota fiscal	Texto	4000 posições

Tributações dos itens da ordem de compra

Url: /api/purchase_order_item_tax

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
purchase_order_id *	Identificador da ordem de compra	Inteiro	11 dígitos
purchase_order_item_id *	Identificador do item da ordem de compra	Inteiro	11 dígitos
cfop *	Identificador da cfop	Inteiro	11 dígitos
cst	CST do item	Texto	3 posições
icms_rate	Taxa de icms	Decimal	20 dígitos e 2 decimais
icms_totalizer	Totalizador de icms	Texto	7 posições
icms_basis	Identificador da base de ICMS	Inteiro	11 dígitos
icms_amount	Total de ICMS	Decimal	20 dígitos e 2 decimais
icms_discount	Valor de desconto de ICMS	Decimal	20 dígitos e 2 decimais
icms_addition	Valor de acréscimo de ICMS	Decimal	20 dígitos e 2 decimais
icms_canceled	Valor de ICMS cancelado	Decimal	20 dígitos e 2 decimais
icms_st	Valor de ICMSST	Decimal	20 dígitos e 2 decimais
icms_not_incident	Valor de ICMS não incidente	Decimal	20 dígitos e 2 decimais
icms_free	Valor livre de ICMS	Decimal	20 dígitos e 2 decimais
issqn_rate	Taxa de ISSQN	Decimal	20 dígitos e 2 decimais
issqn_totalizer	Totalizador do ISSQN	Texto	7 posições
issqn_basis	Base do ISSQN	Decimal	20 dígitos e 2 decimais
issqn_amount	Total de ISSQN	Decimal	20 dígitos e 2 decimais
issqn_discount	Valor de desconto de ISSQN	Decimal	20 dígitos e 2 decimais
issqn_addition	Valor de acréscimo de ISSQN	Decimal	20 dígitos e 2 decimais
issqn_canceled	Valor de ISSQN cancelado	Decimal	20 dígitos e 2 decimais
issqn_st	Valor de ISSQNST	Decimal	20 dígitos e 2 decimais
issqn_not_incident	Valor de ISSQN não incidente	Decimal	20 dígitos e 2 decimais
issqn_free	Valor livre de ISSQN	Decimal	20 dígitos e 2 decimais
ipi_rate	Taxa de IPI	Decimal	20 dígitos e 2 decimais
ipi_amount	Total de IPI	Decimal	20 dígitos e 2 decimais
other_taxes	Valor de outras taxas	Decimal	20 dígitos e 2 decimais

Unidade de Medida

Url: /api/measure_unit

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome da unidade de medida	Texto	255 posições
symbol *	Simbolo da unidade de medida	Texto	30 posições
active *	Flag que indica se a unidade esta ativa ou não	Booleano

Usuários

Url: /api/user

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome do usuário	Texto	255 posições
email *	Email do usuário	Texto	255 posições
user_type *	Identificador do tipo de usuário	Inteiro	11 dígitos
id_facebook	Id do facebook	Texto	255 posições
active	Flag de ativo	Booleano

Vendedores

Url: /api/seller

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name *	Nome	Texto	255 posições
person_type *	Tipo de pessoa	Texto	255 posições	F =Físca J = para jurídica
doc_cnpj	CNPJ	Texto	14 posições
doc_ie	Inscricao estadual	Texto	100 posições
doc_im	Inscricao municipal	Texto	100 posições
doc_cpf	CPF	Texto	11 posições
contact_name	Nome de contato	Texto	255 posições
contact_email	Endereço de email	Texto	255 posições
contact_phone	Telefone	Texto	11 posições
contact_cellphone	Celular	Texto	11 posições
gender	Sexo	Texto	1 posições	M = Masculino F = feminino
birthday	Data de nascimento	Data
commission	Valor da comissão	Decimal	20 dígitos e 2 decimais
hours_by_day	Horas por dia	Decimal	3 dígitos e 2 decimais
days_off_week	Dias por semana	Inteiro	11 dígitos
address_street	Descrição da rua	Texto	255 posições
address_number	Número	Texto	10 posições
address_complement	Complemento do endereço	Texto	255 posições
address_district	Identificador do bairro ou descrição do bairro	Inteiro	11 dígitos
address_city	Identificador da cidade ou descrição da cidade	Inteiro	11 dígitos
address_state	Identificador do estado ou descrição do estado	Inteiro	11 dígitos
address_zip_code	Identificador do CEP ou número do CEP	Inteiro	11 dígitos
active	Flag de ativo	Booleano
code	Código interno	Texto	255 posições
address_country	Identificador do país	Inteiro	11 dígitos

Items Extras Pedido

Url: /api/sales_order_item_extra

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
sales_order_item_id	Identificador do item do pedido	Inteiro	11 dígitos
product_id	Identificador do item adiconal ou retirado	Inteiro	11 dígitos
qtd	Quantidade	Decimal	20 dígitos e 2 decimais
additional	Flag que identifica se é adicional ou retirado	Booleano
price	Valor do unitário do item extra	Decimal	20 dígitos e 2 decimais
total_price	Valor total do item	Decimal	20 dígitos e 2 decimais

Ficha de Produção

Url: /api/product_productions

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
product_id	Identificador do produto insumo	Inteiro	11 dígitos
product_production_id	Identificador do produto produzido	Inteiro	11 dígitos
gross_qtd	Quantidade bruta	Decimal	20 dígitos e 4 decimais
net_qtd	Quantidade líquida	Decimal	20 dígitos e 4 decimais
price_cost	Preço de Custo	Decimal	20 dígitos e 2 decimais
utilization	Percentual de utilização	Decimal	20 dígitos e 2 decimais
participation_cost	Percentual de participação no custo	Decimal	20 dígitos e 2 decimais

Coleções

Url: /api/product_collection

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome da coleção	Texto	255 posições
active	Flag de ativo	Booleano

Referência do Produto no Fornecedor

Url: /api/product_supplier_reference

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
product_id	Identificar do produto	Inteiro	11 dígitos
grid	Identificar da grade	Inteiro	11 dígitos
line_feature	Identificar do valor da característica de linha	Inteiro	11 dígitos
column_feature	Identificar do valor da característica de coluna	Inteiro	11 dígitos
supplier	Identificador do fornecedor	Inteiro	11 dígitos
code	Código do produto no fornecedor	Texto	255 posições

Classificação dos Produtos

Url: /api/product_tree

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
code	Código do nível de classificação	Texto	20 dígitos
name	Nome do nível de classificação	Texto	255 dígitos
product_tree_id	Identificar do nível pai da classificação	Inteiro	11 dígitos
product_category_id	Identificador da categoria do produto	Inteiro	11 dígitos
level	Nível da classificação	Inteiro	11 dígitos
active	Flag de ativo	Booleano

Tags

Url: /api/tags

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
name	Nome da tag	Texto	255 dígitos

Relações das Tags

Url: /api/tags_relation

Atributos:

Nome	Descrição	Formato	Tamanho	Valores Válidos
id	Identificador do registro	Inteiro	11 dígitos
tag_id	Identificar da tag	Inteiro	11 dígitos
model_class	Nome da classe que vai vincular a tag	Texto	255 dígitos	Produtos pais ou avulsos = Product Produtos filhos = ProductGrid
model_id	Identificar do produto avulsopai ou produto filho	Texto	255 dígitos