Cliente - inncash/inncash-docs GitHub Wiki

Introdução

Web service responsável pelas as operações relacionadas a cliente. Existem dois endereços nesse web service, um sendo referente atualização/criação de dados, e outro referente a exclusão. Pontos de atenção:

Nas requisições será necessário especificar o identificador da empresa por meio do "company_id" (fornecido pela Innova no momento de implantação). Ele deverá ser enviado no header da requisição com esse formato: Company-Ids: []
O campo "refresh_all" quando ativo irá excluir todos os registros da tabela para a empresa específica e importar novamente do zero. Essa opção deve ser utilizada no momento de implantação para testes, não é recomendável utilizar em produção.

Requisições

Post: URL_BASE/customers

Corpo da requisição :

{	
    "refresh_all": false,
    "data": [
        {
             "id": "3B18FBC187D8E7978C8510BF894C0FE0",
             "code": "1489409425",
             "store_code": "0001",
             "legal_entity": "F",
             "state_address": "SC",
             "document": "94299378204020",
             "name": "Wolff-Raynor",
             "trade_name": "Koepp Wuckert and Boyle",
             "address": "48300 Ceasar Divide New Murphy, AK 02288-0539",
             "type": "S",
             "city_address": "Port Sydney",
             "neighborhood_address": "269 Becker Place Denesikville",
             "receiving_method": "001",
             "billing_address": "919 Schmidt Lights Stuartbury",
             "billing_neighborhood_address": "356 Kemmer Parkway North Wyma",
             "postal_code": "88000000",
             "billing_postal_code": "88000000",
             "billing_city_address": "Simeonmouth",
             "billing_state_address": "UC",
             "payment_method": "Nj0",
             "ddd_code": "48",
             "telephone": "+17479752821",
             "country": "105",
             "sector": "123",
             "District": "124",
             "group": "001",
             "subgroup": "01",
             "cond": "001",
             "limited": "1325.20",
             "balance_owed": "1325.20",
             "bank1": "001",
             "bank2": "003",
             "risk": "A",
             "class": "A",
             "first_purchase": "10/01/2023",
             "last_purchase": "10/10/2023",
             "telephone_second": "+17479752821",
             "mail": "[email protected]",
             "mail_nfe": "[email protected]",
             "mail_credit_first": "[email protected]",
             "mail_credit_second": "[email protected]",
             "table_company_code": "01",
             "group_name": "client",
             "branch_token": "123645",
             "company_token": "123645",
             "data_origin": "SINC-DATA",
             "mail_finance": "[email protected]",
             "company_id": "35",
             "complement": "teste",
             "blocked": "S",
             "agency_customer": "1234",
             "bank_customer": "001",
             "agency_check_digit": "1",
             "account_check_digit": "1",
             "account_number": "1234567",
             "standard_account_type": "1",
             "nome_bank": "BANCO DO BRASIL",
             "document_customer": "12213515",
             "type_charge": "1",
             "observation": "teste",
             "average_purchase": "30",
             "average_delay": "30",
             "type_pix": "1",
             "key_pix": "12121"

        }
    ]
}

Campos

Tipo	Nome	Descrição	Obrigatório	Tamanho
String	id	Identificador único do registro	X	254
String	code	Código que individualiza cada um dos clientes da empresa.	X	11
String	store_code	Código que identifica a loja do Cliente.	X	4
String	legal_entity	Tipo de pessoa: F - Física; J - Jurídica.	X	1
String	state_address	Unidade da federação do cliente.		2
String	document	CNPJ ou CPF.	X	14
String	name	Nome ou razão social do cliente.	X	250
String	trade_name	Nome reduzido do cliente.	X	250
String	address	Endereco do cliente.	X	60
String	type	Tipo de Cliente: Opções Brasil (L,F,R,S,X): L - Produtor Rural; F - Cons.Final; R - Revendedor; S - ICMS Solidário sem IPI na base; X - Exportação. Outros Países: Verificar opções disponíveis.	X	1
String	city_address	Município do cliente.		60
String	neighborhood_address	Bairro do cliente.		30
String	receiving_method	Método de recebimento.		3
String	billing_address	Endereço de cobrança do cliente.		40
String	billing_neighborhood_address	Bairro de cobrança.		30
String	postal_code	Código de endereçamento postal do cliente.		10
String	billing_postal_code	CEP de cobrança.		8
String	billing_city_address	Municipio de cobrança.		15
String	billing_state_address	Estado de cobrança.		2
String	payment_method	Método de pagamento.		3
String	ddd_code	Código do DDD do cliente.		3
String	telephone	Número do telefone do cliente.		20
String	country	Codigo do pais do cliente		5
String	sector	Codigo do setor do cliente		10
String	District	Codigo do distrito do cliente		10
String	group	Codigo do grupo de cliente		10
String	subgroup	Codigo do sub grupo do cliente		10
String	cond	Codigo da condição de pagamento do cliente		5
String	limited	Valor do limite de credito do cliente		20
String	balance_owed	Saldo devedor do cliente		20
String	bank1	Codigo do primeiro banco do cliente		3
String	bank2	Codigo do segundo banco do cliente		3
String	risk	Codigo do risco do cliente		1
String	class	Codigo da classe do cliente		5
String	first_purchase	Data da primeira compra do cliente		10
String	last_purchase	Data da ultima compra do cliente		10
String	telephone_second	Telefone secundario do cliente		10
String	mail	Email do cliente		20
String	mail_nfe	Email refernete a NFE do cliente		20
String	mail_credit_first	Email primario referente ao credito do cliente		20
String	mail_credit_second	Email secundario referente ao credito do cliente		20
String	mail_finance	Email do finaceiro do cliente		20
String	complement	complemento do cliente		40
String	blocked	Status do cliente		1
String	agency_customer	Agencia		10
String	bank_customer	Banco		3
String	agency_check_digit	Digito da agencia		10
String	account_check_digit	Digito da conta		1
String	account_number	Numero da Conta		20
String	standard_account_type	Tipo de conta		3
String	nome_bank	Nome do Banco primario		20
String	document_customer	CPF do Favorecido		14
String	type_charge	Tipo de cobrança		3
String	observation	Observação		40
String	average_purchase	Maior compra		20
String	average_delay	Média de atraso		10
String	type_pix	Tipo de PIX		10
String	key_pix	Chave PIX		40
String	table_company_code	Nome da Tabela origem no ERP		20
String	group_name	Nome da Tabela origem no ERP		20
String	branch_token	Id único da filial na tabela de bancos por cliente		40
String	company_token	Id único da empresa na tabela de bancos por cliente		10
String	data_origin	Conteudo da origem que veio os dados para o inncash		40
String	company_id	id da empresa no inncash		20

Delete: URL_BASE/customers/{id}

O "id" é o campo que identificador que que define o registro

Resposta HTTP

Código	Mensagem	Descrição
200		Operação realizada com sucesso
422	Data invalid	Ocorre quando alguma informação obrigatória deixa de ser enviada
404	Configurações de empresa necessárias não encontradas	Dentro do Inncash, a configuração para essa tabela não foi encontrada, entre em contato com o administrador do sistema.
500	Erro interno do servidor	Erro interno no servidor