Você está na página 1de 29

Manual de Integração

API Bravologic
versão 04.2023
Sumário

1.FLUXO DE PROCESSAMENTO..................................................................................................... 3
1.Formatos de comunição............................................................................................................ 4
1.1Formato de envio.................................................................................................................... 4
1.1.1Consultando......................................................................................................................... 4
1.1.2Inserindo / Editando pedido................................................................................................. 5
1.1.3Atributos de colunas............................................................................................................. 5
1.1Formato de retorno................................................................................................................. 5
1.1.1Tratamento de erros............................................................................................................ 6
1.1.2Tratamento de alertas.......................................................................................................... 7
2.LAYOUTS.................................................................................................................................... 7
2.1Unidades de Produtos............................................................................................................. 7
2.2Categorias de Produtos........................................................................................................... 8
2.3Sub-Categorias de Produtos.................................................................................................... 8
2.4Produtos.................................................................................................................................. 9
2.5Entidades (Estabelecimentos/Clientes/Fornecedores).......................................................... 11
2.6Grades de Compras............................................................................................................... 13
2.7Pedidos.................................................................................................................................. 15
2.8Compras................................................................................................................................ 17
2.9Pré-Movimentações.............................................................................................................. 19
2.10Atualização de Status de Integração de Pré-Movimentações .............................................22
2.11Movimentações de Estoque................................................................................................ 22
2.12Saldo de Estoque................................................................................................................. 24
2.13Formas de Pagamento ........................................................................................................ 25
3.ERROS COMUNS...................................................................................................................... 25
1. FLUXO DE PROCESSAMENTO
1. Formatos de comunição

-Deverá ser enviada uma requisição HTTP POST para a URL relativa a ação desejada.

- As requisições HTTP POST devem possuir a configuração:


Content Type: application/x-www-form-urlencoded

- Os parâmetros devem sem codificados em HTML(caracteres especiais) .

Toda requisição deve obrigatoriamente enviar o parâmetro TOKEN para sua identificação:

Campo Formato Observações


token Texto Chave de identificação do cliente no sistema on-line.

1.1 Formato de envio

1.1.1 Consultando

Só é possível efetuar uma requisição de consulta por vez.

Cada consulta deverá ter o intervalo de 15 segundos entre requisições, a consulta de estoque
(/stock-balance/search) deve ter intervalo de 1 minuto, e as demais consultas intervalo de 30
minutos.

Formato:

Campo Formato Observações


columns Texto Colunas a serem selecionadas (para lista de colunas
disponíveis, vide retorno abaixo).
Vazio para consultar todas
Ex:
"prod_id, reference"
condition Texto(Condição Condição MySQL.
MySQL) Ex:
"integrated = ‘false’ "
limit Número Inteiro Limite de registros
Caso não informado, utiliza limite de 300 como padrão
offset Número Inteiro Intervalo
order_column Texto Coluna de ordenação, seguida da orientação.
Ex:
“product_id ASC”: ordena por product_id Crescente
“product_id DEC”: ordena por product_id Decrescente
1.1.2 Inserindo / Editando pedido

Suporte a múltiplas requisições.

Para se efetuar a atualização de um registro NÃO é necessário informar todas as colunas,


apenas as que se deseja alterar.

Existem regras e limites para registro de pedidos que estão descritas abaixo.

– Nas primerias 10 tentativas, intevalo minimo de 10 segundos.

– A partir da 11ª tentativa, intevalo mínimo de 10 minutos.

– A partir da 20ª tentativa, intervalo mínimo de 1 hora.

– A partir da 30ª tentativa, não será mais registrado (pedido foi bloqueado por erro na
integração)

Formato:

Campo Observações
campo[id_request] Um para um
Ex: Dados gerais de uma empresa
name[0] = My Company LTDA
trade_name[0] = My Company

camposMultiplos[id_request][] Vários para um


Ex: Contatos de uma empresa

contact_name[0][0] = Person 1
contact_individual_register[0][0] = 10209987

contact_name[0][1] = Person 2
contact_individual_register[0][1] = 23657810

1.1.3 Atributos de colunas

Estes atributos estão especificados para cada coluna na sessão LAYOUTS deste documento.
Atributo Descrição

Campo utilizado como referência.


REF Através dele será possível identificar se o cadastro está sendo criado ou
alterado.

REQ Campo requerido.


De preenchimento obrigatório na inserção

1.1 Formato de retorno


Campo Formato

Respostas (N)

response[]( Texto

Status (1:1)

status Texto “success”,”error”

Erros (1:1)
errors( Array
code Número inteiro
message Mensagem de erro
extra Dados extras
)

Alertas (1:1)

warnings( Array
Code Número inteiro
message Mensagem de erro
extra Dados extras
)

Dados (1:1)

data( Array
)
)

1.1.1 Tratamento de erros

Cada erro gerado trará um código e sua respectiva descrição.

Legenda de códigos:
Código Significado

1.1 Acesso negado, você deve enviar uma solicitação HTTP POST.

1.2 Acesso negado, token inválido.

1.3 Acesso negado, você não possui permissões para efetuar essa ação.

2 Erro de MySql.

3 Erro de validação

3.1.1 Erro de validação. CPF/CNPJ inválido.

3.1.2 Erro de validação. Cadastro de contato: cidade não encontrada

3.1.3 Erro de validação. Cadastro de referência: cidade não encontrada

3.2.1 Erro de validação. O sub-grupo do produto não pertence ao grupo.

3.3.1 Erro de validação. A entidade não pode ser nula ou não existe na base de dados.

3.3.2 Erro de validação. O código GTIN do produto não existe na base de dados.

3.3.3 O pedido não pode ser atualizado pois já foi autorizado.

3.3.4 O pedido não pode ser atualizado pois já foi negado.

3.3.5 Erro de validação. Produto inexistente na base de dados.

3.3.6 Erro de validação. A unidade do produto não pode ser nula ou não existe.

3.3.7 Erro de validação. Unidade incorreta para o produto, favor verificar o cadastro de produtos.

Erro de validação. Configuração de unidade padrão de estoque incompatível, favor contactar


3.3.8
o suporte.

3.3.9 Erro de validação. Estoque não encontrado.

3038 Erro de validação. Produto indisponível para pedido.

3039 Erro de validação. Quantidade indisponível para este produto.

1.1.2 Tratamento de alertas

Cada alerta gerado trará um código e sua respectiva descrição.

Legenda de códigos:

Código Significado
2100 Item da grade de compra registrado parcial devido a falta de quantidade disponivel.

2101 Item da grade de compra removido devido a falta de quantidade disponivel.

2. LAYOUTS

2.1 Unidades de Produtos


URL Consulta: http://www.centralflex.com/api/product-unit/search

URL Gravação: http://www.centralflex.com/api/product-unit/register

ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados Gerais (1:1)

REF REQ product_unit_id Número inteiro ID da unidade

REF REQ abbreviation Texto Abreviação


Ex: UN, PCT, CX

description Texto Descrição


Ex: Unidade, Pacote, Caixa

REQ amount_per_package Número decimal Quantidade por embalagem

integrated Boolean Integrado(status para saber se o item está


(true/false) aguardando integração)

deleted Boolean Deletado (status da unidade)


(true/false)

2.2 Categorias de Produtos


URL Consulta: http://www.centralflex.com/api/product-category/search

URL Gravação: http://www.centralflex.com/api/product-category/register

ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados Gerais (1:1)

REF REQ product_category_id Número inteiro ID da categoria

REF REQ title Texto Titulo


Ex: Alimento, Limpeza
integrated Boolean Integrado(status para saber se o item está
(true/false) aguardando integração)

deleted Boolean Deletado (status da unidade)


(true/false)

2.3 Sub-Categorias de Produtos


URL Consulta: http://www.centralflex.com/api/product-sub-category/search

URL Gravação: http://www.centralflex.com/api/product-sub-category/register

ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados Gerais (1:1)

REF REQ
product_sub_category_id Número inteiro ID da sub-categoria
Titulo
REF REQ title Texto
Ex: Macarrão, Amaciantes
REQ product_category_id Número inteiro ID da Categoria a qual pertence.

product_category_title Texto Titulo da Categoria qual pertence

Boolean Integrado(status para saber se o


integrated
(true/false) item está aguardando integração)

Boolean
deleted Deletado (status da unidade)
(true/false)

2.4 Produtos
URL Consulta: http://www.centralflex.com/api/product/search

URL Gravação: http://www.centralflex.com/api/product/register

Com os seguintes campos:

ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados Gerais (1:1)


REF REQ Número
product_id ID do Produto
inteiro
Referência. Código do
Número produto em referencia a
REF reference
inteiro outros sistemas de
identificação.

REF gtin_code Texto Código GTIN

Nomenclatura Comum
ncm Texto
do MERCOSUL
Titulo
REF REQ title Texto
Ex: Macarrão, Amaciantes

Boolean ID da Categoria do
product_category_id
true/false produto.

Título da Categoria do
product_category_title Texto
produto
Número Id da Sub-Categoria do
REQ product_sub_category_id
inteiro produto
Título da Sub-Categoria do
REQ product_sub_category_title Texto
produto
Descrição geral do produto
Ex: TV LCD 42 polegadas,
description Texto
FULL HD com 2 portas
HDMI
Valor padrão para
quantidade múltipla
Número
default_purchasing_grid_rule_mult_unit_amount requerida (unitária) ao
Decimal
utilizar o produto em uma
grade de compra.

Unidade / Preço de COMPRA (1:1)

Número ID da Unidade de compra do


REQ purchasing_product_ unit_id
inteiro produto
Abreviação da unidade de
REQ purchasing_product _unit_abbreviation Texto
compra do produto
Quantidade por embalagem
Número
REQ purchasing_product_unit_amount_per_package da unidade de compra do
Decimal
produto
Número
REQ purchasing_unit_price Preço Unitário de Compra
Decimal

Unidade/ Lucro / Preço de VENDA (1:1)

Número ID da Unidade de venda do


REQ sales_product_ unit_id
inteiro produto

Abreviação da unidade de
REQ sales_product_unit_abbreviation Texto
venda do produto
Quantidade por embalagem
Número
REQ sales_product_ unit_amount_per_package da unidade de venda do
Decimal
produto

Texto Tipo de Lucro


sales_markup_type “pct” ou pct = porcentagem
“fixed” fixed = fixo
Valor do lucro, referente ao
Número
sales_markup_value seu tipo(porcentagem ou
Decimal
fixo).
Número
REQ sales_unit_price Preço Unitário de venda
Decimal

Integrado(status para saber


Boolean
integrated se o item está aguardando
true/false
integração)

Boolean
deleted Deletado (status da unidade)
true/false

2.5 Entidades (Estabelecimentos/Clientes/Fornecedores)


URL Consulta: http://www.centralflex.com/api/entity/search

URL Gravação: http://www.centralflex.com/api/entity/register

ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados Gerais (1:1)

REF REQ entity_id Número inteiro ID da entidade

REQ type Boolean Tipo de pessoa


(“person”,”comp person: física
any”) company:jurídica
REF REQ name Texto Nome / Razão Social

trade_name Texto Nome fantasia

REF REQ individual_register Texto CPF / CNPJ


brazil_ie_rg Texto Inscrição Estadual / RG
gender Boolean(“m”,”f”) Sexo:
m = masculino
f = feminino
birth_year Data “ano-mês- Ano de Nascimento
dia”
observations Número inteiro Valor unitário
payment_form_available Texto IDS das formas de pagamento.
Separados por “;”

Contatos (1:N)

contacts( Array
REF REQ contact_name Texto Nome
REF contact_individual_register Texto CPF / CNPJ
REF contact_description Texto Descrição do contato
ex: “Gerente”
contact_brazil_rg Texto RG
contact_phone_number Texto Nº do telefone
contact_cell_number Texto Nº do celular
contact_email Texto E-mail
contact_more_info Texto Informações adicionais
)

Endereços (1:N)

REQ addresses( Array


REF address_city_id Número inteiro ID da cidade
REF address_city_brazil_ibge_code Texto Código IBGE da
cidade
REF REQ address_city_name Texto Nome da cidade
REF address_state_id Número inteiro ID do Estado
REF address_state_acronym Texto Sigla do Estado
REF address_state_name Texto Nome do Estado
REF address_address Texto Endereço
REF address_number Texto Número
address_zip_code Texto CEP
address_neighbourhood Texto Bairro
address_phone_number Texto Nº telefônico do
estabelecimento
address_cell_number Texto Nº celular do
estabelecimento
address_fax_number Texto Nº do fax do
estabelecimento
address_email Texto E-mail do
estabelecimento
address_contact_person Texto Pessoa para
contato
)

Referências (1:N)

REQ references( Array Referências

REF REQ reference_type “bank” ou ”comercial” Tipo de


referência
REF REQ reference_company_name Texto Nome da
empresa
REF reference_city_id Número inteiro ID da cidade
REF REQ reference_city_name Texto Nome da
cidade
REF reference_city_brazil_ibge_c Texto Código IBGE
ode da cidade
REF reference_state_id Número inteiro ID do Estado
REF reference_state_acronym Texto Sigla do
Estado
REF reference_state_name Texto Nome do
Estado
REF reference_phone_number Texto Nº telefônico
do
estabelecimen
to
reference_contact_name Texto Nome do
contato
reference_contact_occupati Texto Ocupação. Ex:
on “gerente”
reference_costumer_since Número inteiro Cliente desde
(ano)
reference_last_purchase_da Data “ano-mês-dia” Data da ultima
te compra
reference_last_purchase_pri Número decimal Valor da
ce ultima compra
reference_cobservations Texto Observações
)
integrated Boolean Integrado(stat
(true/false) us para saber
se o item está
aguardando
integração)
deleted Boolean Deletado
(true/false) (status da
entidade)
)
2.6 Grades de Compras
URL Consulta: http://www.centralflex.com/api/purchasing-grid/search
ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados Gerais (1:1)

REF REQ
purchasing_grid_id[] Número inteiro ID da grade

REF REQ title[] Texto Título


Data e hora
REQ start_date[] “ano-mês-dia Data inicial
hora:min:seg”
Data e hora
end_date[] “ano-mês-dia Data final
hora:min:seg”
Texto
“active”,
”waiting”,
status[] Status
”canceled”,
”finished”,
”expired”
items( Array
REF purchasing_grid_item_id[][] Número inteiro ID do item

REF item_id[][] Número inteiro ID do produto

REF item_product_gtin_code[][] Texto GTIN

item_product_title[][] Texto Título

item_product_title_prefix[][] Texto Prefixo

item_product_ unit_id[][] Número inteiro ID da unidade

Abreviação da
item_product_unit_abbreviation[][] Texto
unidade

item_product_unit_amount_per_package Número Quantidade unit da


[][] Decimal embalagem

Número Preço da
item_package_price[][]
Decimal embalagem

Número
item_unit_price[][] Preço unitário
Decimal

Regras (1:1)
Número Quanitdade unit
item_rule_available_unit_amount[][]
Decimal disponível

Número Quantidade unit


item_rule_min_unit_amount[][]
Decimal mínima

Número Quantidade unit


item_rule_max_unit_amount[][]
Decimal máxima

Número Quantidade unit


item_rule_mult_unit_amount[][]
Decimal múltipla

item_rule_available_package_amount[] Número Quantidade


[] Decimal diponível

Número Quantidade
item_rule_min_package_amount[][]
Decimal mínima

Número Quantidade
item_rule_max_package_amount[][]
Decimal máxima

Número Quantidade
item_rule_mult_package_amount[][]
Decimal múltipla

item_rule_enable_unit_amount_order[] Bool Possibilita pedido


[] (true/false) unitário

Regras de venda casada (1:N)

Regras de venda
item_sale_joint( Array
casada

Regra

a_cada: Ex: a cada


5 UND leva 1...
item_type[] Texto
acima_de: Ex:
acima de 5 UND
leva 1...

Número
item_amount[] Quantidade
Decimal

Abreviação da
item_unit_abbreviation[] Texto
unidade
Item_takes( Array

takes_id[][] Número Inteiro ID do item

takes_product_gtin_code[][] Texto GTIN

takes_product_id[][] Número Inteiro ID do produto

takes_product_title[][] Texto Título

Número
takes_product_unit_id[][] ID da unidade
Decimal

Abreviação da
takes_product_unit_abbreviation[][] Texto
unidade

takes_product_unit_amount_per_packa Número Quantidade unit da


ge[][] Decimal embalagem

Número Quantidade
takes_product_package_amount[][]
Decimal embalagem

Número Quantidade
takes_product_unit_amount[][]
Decimal unitária

Número Percentual de
takes_product_discount_percentage[][]
Decimal desconto

Número Preço da
takes_product_package_price[][]
Decimal embalagem

Número
takes_product_unit_price[][] Preço unitário
Decimal

)
Desconto por volume (1:N)

item_volume_discount( Array

Número Quantidade
volume_discount_package_amount[]
Decimal embalagem

Número Quantidade
volume_discount_unit_amount[]
Decimal unitária

Número Porcentagem de
volume_discount_percentage[]
Decimal desconto

Número Valor final da


volume_discount_package_price[]
Decimal embalagem

Número
volume_discount_unit_price[] Valor final unitário
Decimal

Status (1:1)
Boolean
Item_integrated[] Item integrado
(true/false)
Boolean
item_deleted[][] Item excluído
(true/false)
)

Boolean
integrated[] Integrado
(true/false)

Boolean
deleted[] Excluído
(true/false)

2.7 Pedidos
URL Consulta: http://www.centralflex.com/api/order/search

URL Gravação: http://www.centralflex.com/api/order/register

ATRIB CAMPO FORMATO OBSERVAÇÕES


Estabelecimento utilizador do sistema (1:1)

REF REQ estab_individual_register[] Texto CPF / RG

Dados gerais (1:1)

REF order_id[] Número Inteiro ID do pedido


ID do Pedido de TERCEIRO.
Utilizado para registrar o ID do
REF order_external_id[] Número Inteiro
pedido vindo de sistemas de
terceiros.
payment_form_id[] Número inteiro ID da FORMA DE PAGTO

ID da ENTIDADE
sales_represent_id[] Número inteiro
REPRESENTANTE(vendedor)
Data e hora
order_date[] “ano-mês-dia Data do pedido
hora:min:seg”
Caso informado true, permite
Boolean
order_partial_register[] registrar pedido parcial (em
(true/false)
caso de falta de estoque)

Status do pedido (1:1)

Autorizado:
Texto true: sim
status_authorized[]
“true”,”false”,”waiting” false: não
waiting: aguardando
Texto
status_pre_billed[] Pré-Faturado
“true”,”false”

ENTIDADE destinatária do pedido - (1:1)

REF REQ entity_id[] Número inteiro ID da ENTIDADE

REF REQ entity_name[] Texto Nome/Raz Social

REF REQ entity_individual_register[] Texto CPF / RG

Itens (produtos / serviços) (1:N)

REQ items( Array Referências


REF order_item_id[][] Número inteiro ID do item do pedido
ID do Item de Pedido de
TERCEIRO.
order_item_extern
REF Número inteiro Utilizado para registrar o ID do
al_id[][]
pedido vindo de sistemas de
terceiros.
item_purchasing_gr
REF Número inteiro ID do item da Grade de Compra
id_item_id[][]

Tipo do item:
Boolean(“product”
REF REQ item_type[][] product: produto
,”service”)
service: serviço

REF REQ item_id[][] Número inteiro ID do Produto / serviço

item_product_gtin_
REF REQ Texto Código GTIN
code[][]
REQ item_product_unit Número inteiro ID da unidade
_id[][]
REQ item_product_unit_ Texto Abreviação
abbreviation[][] Ex: UN, PCT, CX
REQ item_product_unit_ Texto Descrição
description[][] Ex: Unidade, Pacote, Caixa
REQ item_product_unit_ Número decimal Quantidade unitária por
amount_per_packag embalagem
e[][]
item_unit_amount[
REQ Número decimal Quantidade Unitaria
][]
item_unit_liq_price
REQ Número decimal Valor Unitário Líquido
[][]

item_observations[
REQ Texto Observações para o item
][]
Autorizado:
Texto
item_status_author true: sim
“true”,”false”,”wai
ized[][] false: não
ting”
waiting: aguardando
item_status_pre_bi Texto
Pré-Faturado
lled[][] “true”,”false”
Boolean Integrado(status para saber se o
item_integrated[][] (true/false) pedido está aguardando
integração)
Boolean Integrado(status para saber se o
item_deleted[][] (true/false) pedido está aguardando
integração)
)
integrated[] Boolean Integrado(status para saber se o
(true/false) pedido está aguardando
integração)
deleted[] Boolean Deletado (status da entidade)
(true/false)

2.8 Compras
URL Consulta: http://www.centralflex.com/api/purchase/search

URL Gravação: não disponível.


ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados da Compra (1:1)

Número
REF purchase_id ID da Compra
inteiro
Texto Tipo de faturamento
billing_type “direct”,”cen direct: direto
tral” central: via central de distribuição
Data e hora
“ano-mês-
date dia Data da Compra
hora:minuto
s:segundos”
Data e hora
deadline “ano-mês- Prazo de Entrega
dia”
Dados do Fornecedor (1:1)
Número
entity_id ID da ENTIDADE
inteiro
entity_name Texto Nome/Raz Social

entity_individual_register Texto CPF / RG

Forma de pagamento (1:1)

payment_form_id Número ID da FORMA DE PAGTO


inteiro
payment_form_title Texto Descrição da FORMA DE PAGTO. Ex:
“30,60 dias”, “A vista com 10% de
desconto”
payment_form_type “cash”,”insta FORMA DE PAGTO
llment” cash = à vista
installment = à prazo
payment_charge_type_id Número ID do TIPO DE COBRANÇA
inteiro
payment_charge_title Texto Titulo do TIPO DE COBRANÇA. Ex:
“Carteira”,”Bloqueto”,”Carne”
payment_form_installments_days( array Dias de vencimento das parcelas.
Ex: array(30, 60, 90)
day[] Número Dia
inteiro
)

Itens (produtos / serviços) (1:N)

items( Array
REF purchase_item_id[] Número inteiro
item_type[] Texto(“product”,”service”)

item_id[] Número inteiro

item_product_gtin_code[] Texto

item_product_unit_id[] Número inteiro

item_product_unit_abbreviation[] Texto

item_product_unit_description[] Texto

item_product_unit_amount_per_package[] Número decimal

item_package_amount[] Número decimal

item_package_liq_price [] Número decimal

item_unit_amount[] Número decimal


item_unit_liq_price [] Número decimal
Boolean
item_reversed[]
(true/false)
Boolean
item_integrated[]
(true/false)
Boolean
item_deleted[]
(true/false)
)
reversed Boolean
(true/false)
integrated Boolean
(true/false)
deleted Boolean
(true/false)

2.9 Pré-Movimentações
URL Consulta: http://www.centralflex.com/api/pre-stock-mov/search

ATRIB CAMPO FORMATO OBSERVAÇÕES

Dados da Pré-Movimentação (1:1)

Número
REF pre_stock_mov_id[] ID da Pré-Movimentação
inteiro
CNPJ do estoque (necessário
stock_individual_register[] Texto no caso de haver múltiplos
estoques)
Data e
hora
“ano-mês-
date[] dia Data da Pré-Movimentação
hora:minu
tos:segund
os”
Dados da Entidade (1:1)
Número
REF entity_id[] ID da ENTIDADE
inteiro
entity_name[] Texto Nome/Raz Social

entity_trade_name[] Texto Nome Fantasia


Boolean
Tipo de pessoa
(“person”,
entity_type[] person: física
”company”
company:jurídica
)
entity_individual_register[] Texto CPF / CNPJ

entity_brazil_ie_rg[] Texto Inscrição Estadual / RG


Número
entity_address_id[] ID do Endereço
inteiro
entity_address_city_id[] Texto ID da cidade

entity_address_city_brazil_ibge_code[] Texto Código IBGE da cidade

entity_address_city_name[] Texto Nome da cidade


Número
entity_address_state_id[] ID do Estado
inteiro
entity_address_state_acronym[] Texto Sigla do Estado

entity_address_state_name[] Texto Nome do Estado

entity_address_address[] Texto Endereço

entity_address_number[] Texto Número

entity_address_neighbourhood[] Texto Bairro


Nº telefônico do
entity_address_phone_number[] Texto
estabelecimento
entity_address_fax_number[] Texto Nº do fax do estabelecimento

entity_address_email[] Texto E-mail do estabelecimento

entity_address_contact_person[] Texto Pessoa para contato

Dados da Nota Fiscal (1:1)

“in” ou in = entrada
REF invoice_type[]
“out” out = saída
“sale”, sale = venda
REF invoice_operation[] “exchange exchange = troca
”, “bonus” bonus = bonificação
Número
REF invoice_number[] Número da Nota Fiscal
inteiro
Número
REF invoice_model[] Modelo da Nota Fiscal
inteiro
Dados da Nota Fiscal REFERENCIADA (1:1)
Número
REF ref_invoice_supplier_id[] ID do Fornecedor
inteiro
REF ref_invoice_supplier_individual_register[] Texto CPF / CNPJ do Fornecedor
Número
REF ref_invoice_number[] Número da Nota Fiscal
inteiro
Número
REF ref_invoice_model[] Modelo da Nota Fiscal
inteiro
REF ref_invoice_serie[] Número Série da Nota Fiscal
inteiro
REF ref_invoice_subserie[] Número Sub-Série da Nota Fiscal
inteiro
ref_invoice_datehour_mov[] Data e Data e hora da movimentação
hora “ano-
mês-dia
hora-
minutos-
segundos”

Forma de pagamento (1:1)

Número
payment_form_id[] ID da FORMA DE PAGTO
inteiro
Descrição da FORMA DE PAGTO.
payment_form_title[] Texto Ex: “30,60 dias”, “A vista com
10% de desconto”
FORMA DE PAGTO
“cash”,”ins
payment_form_type[] cash = à vista
tallment”
installment = à prazo
Número
payment_charge_type_id[] ID do TIPO DE COBRANÇA
inteiro
Titulo do TIPO DE COBRANÇA. Ex:
payment_charge_title[] Texto
“Carteira”,”Bloqueto”,”Carne”
Dias de vencimento das
payment_form_installments_days( array parcelas.
Ex: array(30, 60, 90)
Número
day[][] Dia
inteiro

Pagamento - Parcelas (1:N)

payment_installments( AParcelas

payment_installment_id[][] Número inteiro

number[][] Número inteiro

due_date[][] Data “ano-mês-dia”

price[][] Número decimal


)

Itens (produtos / serviços) (1:N)

items( Array
REF pre_stock_mov_item_id[][] Número inteiro
purchase_item_id[][] Número inteiro

item_type[][] Texto(“product”,”service”)

item_id[][] Número inteiro

item_product_gtin_code[][] Texto

item_product_unit_id[][] Número inteiro

item_product_unit_abbreviation[][] Texto

item_product_unit_description[][] Texto

item_product_unit_amount_per_package[][] Número decimal

item_package_amount[][] Número decimal


item_unit_amount[][] Número decimal
item_unit_liq_price [][] Número decimal
Boolean
item_reversed[][]
(true/false)
Boolean
item_integrated[][]
(true/false)
Boolean
item_deleted[][]
(true/false)
)
Boolean
reversed[]
(true/false)
Boolean
integrated[]
(true/false)
Boolean
deleted[]
(true/false)
)

2.10 Atualização de Status de Integração de Pré-Movimentações


URL: http://www.centralflex.com/api/pre-stock-mov/register-integrated

ATRIB CAMPO FORMATO OBSERVAÇÕES


REF pre_stock_mov_id[] Número ID da Pré-Movimentação
inteiro
integrated[] Boolean Status de integração
(true /
false)

2.11 Movimentações de Estoque


URL Consulta: http://www.centralflex.com/api/stock-mov/search

URL Gravação: http://www.centralflex.com/api/stock-mov/register

Importante: a exclusão de movimentações de estoque é física.

ATRIB CAMPO FORMATO OBSERVAÇÕES

Cabeçalho (1:1)

REF stock_mov_id[] Número ID da Movimentação de Estoque


inteiro
stock_individual_register[] Texto CNPJ do estoque (necessário no
caso de haver múltiplos
estoques)

Dados da Nota Fiscal (1:1)

REQ REF invoice_type[] “in” ou Tipo de Movimentação


“out” in = entrada
out = saída
REQ REF invoice_operation[] “sale”, sale = venda
“exchange”, exchange = troca
“bonus” bonus = bonificação
REQ REF invoice_number[] Número Número da Nota Fiscal
inteiro
REQ REF invoice_model[] Número Modelo da Nota Fiscal
inteiro
REQ REF invoice_serie[] Número Série da Nota Fiscal
inteiro
REF invoice_subserie[] Número Sub-Série da Nota Fiscal
inteiro
REQ invoice_datehour_mov[] Data e hora Data e hora da movimentação
“ano-mês-
dia hora-
minutos-
segundos”
REQ invoice_total_gross_price[] Número Valor total bruto
decimal
REQ invoice_total_liq_price[] Número Valor total líquido
decimal

Dados da Entidade Cliente / Fornecedor (1:1)

Númer
REQ REF entity_id[] o ID da ENTIDADE
inteiro
REQ entity_name[] Texto Nome/Raz Social

REQ entity_individual_register[] Texto CPF / RG

Itens (produtos / serviços) (1:N)

items( Array

REF stock_mov_item_id[] [] Número inteiro

item_pre_stock_mov_items( Array

REF item_pre_stock_mov_item_id[] [] [] Número inteiro

item_pre_stock_mov_item_unit_amount[] [] Número decimal


[]

)
item_purchase_order_items Array

REF item_purchase_order_item_id[][] [] Número inteiro


item_purchase_order_item_ unit_amount[][] Número inteiro
[]
)
REQ item_type[] [] Boolean
“product”,”service

REF REQ item_id[] [] Número inteiro

REF REQ item_product_gtin_code[] [] Texto


REQ item_product_unit_id[] [] Número inteiro

REQ item_product_unit_abbreviation[] [] Texto

item_product_unit_description[] [] Texto

REQ item_product_unit_amount_per_package[] [] Número decimal

REQ item_unit_amount[] [] Número decimal

REQ item_unit_gross_price[] [] Número decimal

REQ item_unit_liq_price [] [] Número decimal

item_deleted[] [] Boolean
(true/false)
)

deleted[] Boolean
(true/false)
2.12 Saldo de Estoque

URL Consulta: http://www.centralflex.com/api/stock-balance/search

URL Gravação: http://www.centralflex.com/api/stock-balance/register

ATRIB CAMPO FORMATO OBSERVAÇÕES

REF REQ product_id[] Número inteiro ID do produto

REF REQ product_gtin_code[] Texto Código GTIN


CNPJ do estoque (necessário no caso
stock_individual_register[] Texto
de haver múltiplos estoques)
ID da unidade em estoque (caso não
stock_unit_id[] Número inteiro informar será tratado como a unidade
padrão unitária da empresa)
Número
REQ stock_balance_amount[] Saldo de estoque do produto
decimal
Número
REQ stock_average_cost[] Custo médio
decimal
Número
REQ stock_last_cost[] Ultimo custo
decimal
stock_balance_reserved_a Número
Quantidade reservada unitária
mount_unit[] decimal
Data e hora
stock_balance_last_modific
“ano-mes-dia Data de última alteração do registro
ation_date[]
hora:min:seg”

2.13 Formas de Pagamento

URL Consulta: http://www.centralflex.com/api/payment-form/search

URL Gravação: http://www.centralflex.com/api/payment-form/register

ATRIB CAMPO FORMATO OBSERVAÇÕES

REF REQ payment_form_id[] Número inteiro ID da forma de pagamento

REQ payment_form_title[] Texto Título


“V” - A vista;
REQ payment_form_type[] Texto
“P” - A prazo;
TIPO DE COBRANÇA(1:1)

REQ billing_type_id Número inteiro ID do tipo de cobrança.

REQ billing_type_title Texto Título do tipo de cobrança.

3. ERROS COMUNS
Erro:
Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 51 bytes)

Solução:
A consulta está retornando muitos registros, utilize um limitador(parâmetros LIMIT E OFFSET)

Você também pode gostar