Atualizar Fornecedor

Atualiza o nome de um fornecedor existente da empresa.

Regras:

O campo name é obrigatório e não pode ser vazio.
Não é possível atualizar para um nome já utilizado por outro fornecedor da empresa.

Use este endpoint para corrigir erros de digitação ou atualizar a razão social de um fornecedor.

curl -X PUT "https://api-sandbox.contasimples.com/suppliers/v1/suppliers/16" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Content-Digest: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "Fornecedor Atualizado LTDA"
}'

import requests
import json

url = "https://api-sandbox.contasimples.com/suppliers/v1/suppliers/16"
headers = {
  "Content-Type": "application/json",
  "Signature-Input": "example_string",
  "Signature": "example_string",
  "Content-Digest": "example_string",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "name": "Fornecedor Atualizado LTDA"
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api-sandbox.contasimples.com/suppliers/v1/suppliers/16", {
  method: "PUT",
  headers: {
  "Content-Type": "application/json",
  "Signature-Input": "example_string",
  "Signature": "example_string",
  "Content-Digest": "example_string",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "name": "Fornecedor Atualizado LTDA"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "Fornecedor Atualizado LTDA"
}`)

    req, err := http.NewRequest("PUT", "https://api-sandbox.contasimples.com/suppliers/v1/suppliers/16", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Signature-Input", "example_string")
    req.Header.Set("Signature", "example_string")
    req.Header.Set("Content-Digest", "example_string")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api-sandbox.contasimples.com/suppliers/v1/suppliers/16')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Put.new(uri)
request['Content-Type'] = 'application/json'
request['Signature-Input'] = 'example_string'
request['Signature'] = 'example_string'
request['Content-Digest'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "name": "Fornecedor Atualizado LTDA"
}'

response = http.request(request)
puts response.body

{
  "id": 16,
  "name": "Fornecedor Atualizado LTDA",
  "type": {
    "id": 1,
    "type": "CUSTOM"
  }
}

{
  "error": "Bad Request",
  "message": "Um ou mais parâmetros da requisição são inválidos.",
  "code": 400,
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "details": [
    "O campo exemplo deve ter um valor entre 5 e 100.",
    "datas devem estar no formato YYYY-MM-DD."
  ]
}

PUT

/suppliers/v1/suppliers/{id}

PUT

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

path

idinteger

Required

Identificador numérico do fornecedor — use o valor do campo id retornado em GET /suppliers/v1/suppliers.

Format: int32

Content-Typestring

Required

The media type of the request body

Options: application/json

header

Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

header

Content-Digeststring

Hash do corpo da requisição no formato da RFC 9530, com sha-256 ou sha-512, por exemplo sha-256=:X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=:. É obrigatório quando a requisição tem corpo e a credencial tem chave pública, e nesse caso o Signature-Input precisa incluir o componente content-digest.

namestring

Required

Novo nome do fornecedor. Deve ser único entre os fornecedores cadastrados.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

idinteger

Required

Identificador numérico do fornecedor — use o valor do campo id retornado em GET /suppliers/v1/suppliers.

Example:

16

Headers

Signature-Inputstring

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Content-Digeststring

Body

application/json

namestring

Required

Novo nome do fornecedor. Deve ser único entre os fornecedores cadastrados.

Example:

Fornecedor Atualizado LTDA

Responses

idinteger

Required

Identificador numérico do fornecedor.

companyIdstring

Sempre retorna o ID da empresa autenticada.

namestring

Required

Nome do fornecedor.

typestring

Required

Tipo do fornecedor. Indica se foi criado pela empresa (CUSTOM) ou é pré-cadastrado pela plataforma (DEFAULT).

Was this page helpful?