Fornecedor - inncash/inncash-docs GitHub Wiki

Introdução

Web service responsável pelas as operações relacionadas a fornecedor. 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:

  1. 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: []
  2. 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/suppliers

Corpo da requisição :

{	
    "refresh_all": false,
    "data": [
        {
             "id": "3B18FBC187D8E7978C8510BF894C0FE0",
             "code": "01234567890",
             "store_code": "0123",
             "type": "0",
             "state_address": "sc",
             "document": "01234567890123",
             "name": "Company Name",
             "trade_name": "trade name",
             "address": "some address",
             "neighborhood_address": "neighborhood address",
             "city_address": "city address",
             "bank_code": null,
             "supplier_agency_code": null,
             "financial_nature_code": "0123456789",
             "account_number": null,
             "payment_condition": "000",
             "accounting_account_code": null,
             "payment_method": "000",
             "document_other_ownership": null,
             "name_other_ownership": null,
             "sending_supplier_voucher": null,
             "bank_account_type": null,
             "agency_digit": null,
             "account_digit": null,
             "pix_key": null,
             "pix_type": null,
        }
    ]
}

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 fornecedores da empresa. X 11
String store_code Código identificador de cada uma das unidades (lojas) de um fornecedor. X 6
String type Tipo do fornecedor. X 1
String state_address Sigla da unidade da federação do endereço do fornecedor. X 3
String document CNPJ/CPF do cliente. 14
String name Nome ou razão social do fornecedor. X 200
String trade_name Nome fantasia, pelo qual o fornecedor é conhecido. 100
String address Endereço do fornecedor. X 60
String neighborhood_address Bairro do fornecedor. 100
String city_address Município do fornecedor. X 70
String bank_code Código do banco a ser pago o título. 3
String supplier_agency_code Código da Agencia do fornecedor. 5
String financial_nature_code Campo utilizado para informar a natureza do título, quando gerado para o módulo financeiro. X 40
String account_number Número da conta corrente do fornecedor. 15
String payment_condition Código da condição de pagamento padrão para o fornecedor. 3
String accounting_account_code Código da conta contábil onde devem ser lançadas as movimentaçöes do fornecedor na integração contábil, se houver. 20
String payment_method Método de pagamento. X 5/td>
String document_other_ownership CNPJ/CPF de outra titularidade. 14
String name_other_ownership Nome de outra titularidade. 70
String sending_supplier_voucher Envio de comprovante do fornecedor. 200
String bank_account_type Tipo de conta bancária. 2
String agency_digit Dígito da agência. 1
String account_digit Dígito da conta. 1
String pix_key PIX. 254
String pix_type Tipo do pix. 6

Delete: URL_BASE/suppliers/{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
⚠️ **GitHub.com Fallback** ⚠️