Skip to content

Dados de um empregador

Request

Retorna um empregador pelo ID.

Security
BasicAuth
Path
idstringrequired

ID do empregador. Pode ser usado tanto _id quanto external_id

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/payment-sources/{id}'

Responses

Empregador encontrado.

Bodyapplication/json
_idstring

Identificador único do recurso, gerado internamente.

Example:"5f5bc225b511a6edec2891f7"
_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example:"2024-09-29T08:00-03:00"
_updatedstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example:"2024-09-29T08:00-03:00"
_etagstring(EtagModel)

Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

namestring

Razão social do empregador.

Example:"TIQUETAQUE SERVICOS DE TECNOLOGIA S.A."
cpfstring^\d{11}$

CPF do empregador. Apenas números, sem máscara. Necessário que exista ou este campo ou o campo CNPJ mutuamente exclusivos.

Example:"01234567890"
cnpjstring^[0-9A-Z]{12}\d{2}$

CNPJ do empregador, sem máscara. Aceita tanto o formato numérico tradicional quanto o alfanumérico (12 caracteres alfanuméricos maiúsculos seguidos de 2 dígitos verificadores). Necessário que exista ou este campo ou o campo CPF mutuamente exclusivos.

Example:"23467093000164"
external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

period_cut_dayinteger, [ 1 .. 31 ]

Data de corte dos espelhos para este empregador. Depois de criado o documento, não é permitida a alteração deste valor através desta API.

addressobject
Response
{
  "_id": "5f5bc225b511a6edec2891f7",
  "_created": "2024-09-29T08:00-03:00",
  "_updated": "2024-09-29T08:00-03:00",
  "_etag": "string",
  "name": "TIQUETAQUE SERVICOS DE TECNOLOGIA S.A.",
  "cpf": "01234567890",
  "cnpj": "23467093000164",
  "external_id": "string",
  "period_cut_day": 1,
  "address": {
    "cep": "90240111",
    "street_name": "RUA FREDERICO MENTZ",
    "street_number": "1606",
    "complement": "LOJA 134 E 135",
    "state": "RS",
    "city": "Porto Alegre"
  }
}