API para criação/alteração de fornecedores de forma simplificada.

O endpoint abaixo permite, através de um POST HTTP, criar ou alterar fornecedores.

Exemplo em cURL

curl 'http://SERVER:PORT/api/supplier/import' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4' \
-d '{
    "items": [
         {
            "reference":"1234", 
            "name":"Fornecedor Xyz", 
            "document":"31.989.895/0001-62", 
            "campoCustom1": true,
            "campoCustom2": 123
        }
    ]
}'

Obs 1: SERVER é o IP ou DNS do servidor onde o sistema Valesoft está instalado e PORT é a porta definida na instalação.

Obs 2: A chamada para esse endpoint necessita autenticação do tipo Basic com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678 => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Definições dos campos do corpo da requisição:

• items - OBRIGATÓRIO

  • Lista de registros a serem criados/atualizados

• reference - OBRIGATÓRIO

  • Alfanumérico
  • Código Único do local
  • Chave Primaria - Utilizado para criação ou alteração do registro

• name - OBRIGATÓRIO

  • Texto
  • Nome do fornecedor

• document

  • Texto
  • Documento do fornecedor - CPF ou CPNJ

• campoCustom1 e campoCustom2

  • Quaisquer nomes de campos personalizados desde que os mesmos estejam devidamente configurados nas configurações de campos personalizados do sistema.

Resposta em caso de sucesso

Retorna a referência com seu respectivo Identificador interno.

{
    "items": [
        {
            "reference":"1234", 
            "id":"00e80f22-9b9d-44d7-bb57-dbb345b90dec"
        }
    ]
}