Permite a criação de novas instâncias de fornecedores. De modo a realizar um pedido para esta rota, terá de enviar alguns parâmetros no body do pedido.
Tal como está descrito no pedido em baixo.
Dentro de data, deverá colocar todos os parâmetros obrigatórios e poderá também colocar os restantes parâmetros, se for do seu interesse. O tipo dos parâmetros está também especificado.
Indica se o fornecedor está isento de impostos (opcional).
Não
self_billing
Indica se o fornecedor permite a autogestão de faturas (opcional).
Não
document_series_id
ID da série de documentos associada ao fornecedor (opcional).
Não
internal_observations
Observações internas sobre o fornecedor (opcional).
Não
tax_country_region
Região fiscal do fornecedor (opcional).
Não
is_independent_worker
Indica se o fornecedor é um trabalhador independente (opcional).
Não
Associar morada a Fornecedor
A sequência de passos delineada no diagrama proporciona uma compreensão do processo, desde a criação do forncedor até a sua associação com uma morada.
Quando um forncedor é criado, uma morada principal fica associada ao fornecedor. Esta morada por default vem vazia e é necessário atualizar com os dados da nova morada do fornecedor.
Através do id obtido pela response do Criar Fornecedor este deverá ser usado para obter o id da morada ao fazer um GET /suppliers/{id}
A seguinte rota permite a remoção de um dado fornecedor. Esta rota deve ser utilizada de forma cautelosa dado que é irreversível, e mesmo que este cliente volte a ser criado, o seu id nunca será o mesmo que teria anteriormente.
Utilizando o id do forncedor que quer eliminar, que poderá fazer utilizando a primeira rota desta página, por exemplo, terá simplesmente de fazer o pedido:
Atualizar Fornecedor
A rota PATCH permite a edição de um fornecedor existente. O body deste pedido deverá ser igual ao descrito na rota POST, contendo todas as informações obrigatórias do fornecedor, atualizadas para os valores que tenciona alterar, além do "id" do fornecedor. Álem disto, o pedido deverá ser feito a https://apiv1.toconline.com/suppliers/{id}, sendo que {id} é o identificador do fornecedor que tenciona atualizar.
Exemplo de Payload
No exemplo que se segue foi atualizado o website da empresa
Quando um Fornecedor é criado este já tem uma morada vazia associada, mas é possível adicionar mais do que uma morada ao Fornecedor.
De modo a associar uma morada a um cliente, deverá realizar o seguinte pedido
No pedido acima, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth, e o <payload JSON> deverá ter o seguinte formato
Payload
{"data": {"type":"addresses","attributes": {"addressable_type":"Supplier",//OBRIGATÓRIO"addressable_id":7,//OBRIGATÓRIO - ID da morada do Fornecedor"address_detail":"teste 3","city":"Setúbal","postcode":"2910-099","region":"Setúbal","country_id":1// 1 = PT (Portugal Continental); 2 = PT_MA (Madeira); //3 = PT_AC (Açores)...Ver Get/countries } }}
Atributo
Descrição
Obrigatório
type
Tipo de entidade (neste caso, endereço).
Sim
addressable_type
Tipo de entidade à qual o endereço está associado (neste caso, fornecedor).
Sim
addressable_id
ID do fornecedor associado ao endereço.
Sim
address_detail
Detalhes específicos do endereço, como rua e número.
Não
city
Cidade do endereço.
Não
postcode
Código postal do endereço.
Não
region
Região do endereço (por exemplo, província, estado).
Não
country_id
ID do país do endereço (1 = Portugal Continental, 2 = Madeira, 3 = Açores).
Não
"addressable_id" - corresponde ao id da morada do cliente obtido da relação entre fornecedor e morada, através do #obter-fornecedor
Para usar outro país que não seja Portugal, poderá consultar mais informação em: Países
E-mail
Criar E-mail de Fornecedor
Para proceder à criação do E-mail de um fornecedor pela primeira vez deverá utilizar a POST / contacts.
O body deste pedido (<payload JSON>) deverá conter as informações de fornecedor que se pretende atualizar, sendo obrigatório campo "contactable_id" identificador do fornecedor que tenciona atualizar e o "contactable_type" sendo este do tipo "Supplier"
Usando o GET / supplier{id} deverá obter o id correspondente ao contacto do fornecedor, que se encontra localizado na área de relationships-> main_contact, como pode observar no exemplo de response abaixo.
Para proceder à atualização do E-mail de um fornecedor deverá utilizar a PATCH / contacts usando o id obtido do main_contact obtido do fornecedor pretendido.
O body deste pedido (<payload JSON>) deverá conter as informações de cliente que se pretende atualizar, sendo obrigatório campo "id" id do contacto correspondente ao utilizador que tenciona atualizar e o "email" novo a ser alterado.
