FornecedoresConsultar Fornecedor por ID

Consultar Fornecedor por ID

Retorna os dados de um fornecedor específico da empresa pelo ID numérico.

Regras:

curl -X GET "https://api-sandbox.contasimples.com/suppliers/v1/suppliers/16" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 16,
  "name": "Fornecedor Fictício LTDA",
  "type": {
    "id": 1,
    "type": "CUSTOM"
  }
}
GET
/suppliers/v1/suppliers/{id}
GET
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

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
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.

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

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.

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.

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).