Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

id
string
required

Identificador do termo na plataforma Salvy.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

companyId
string
required

ID da empresa dona do termo.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

type
enum<string>
required

Tipo do termo: responsibility (termo de responsabilidade, na entrega dos equipamentos) ou return (termo de devolução).

Available options:
responsibility,
return
Example:

"responsibility"

status
enum<string>
required

Situação do termo. pending-signature enquanto o colaborador não assina, signed depois de assinado e canceled quando cancelado ou substituído por um termo mais novo.

Available options:
pending-signature,
signed,
canceled
Example:

"signed"

employeeId
string
required

ID do colaborador que assina o termo.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

assetIds
string[]
required

IDs dos equipamentos listados no termo.

A valid UUID string, in any version.

Example:
createdAt
string<date-time>
required

Data de envio do termo para assinatura.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2025-01-01T00:00:00.000Z"

signedAt
string<date-time> | null
required

Data de assinatura. Nulo enquanto o termo não foi assinado.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2025-01-02T00:00:00.000Z"

canceledAt
string<date-time> | null
required

Data de cancelamento. Nulo quando o termo não foi cancelado.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

null

cancelReason
enum<string> | null
required

Motivo do cancelamento: replaced-by-new-document quando um termo de responsabilidade mais novo foi enviado para algum dos mesmos equipamentos, content-outdated quando um equipamento do termo de responsabilidade passou para outro colaborador antes da assinatura, client-request quando a empresa cancelou o termo e signer-refused quando o colaborador recusou a assinatura. Nulo quando o termo não foi cancelado.

Available options:
client-request,
replaced-by-new-document,
content-outdated,
signer-refused
Example:

null

replacedById
string | null
required

ID do termo que substituiu este. Nulo quando o termo não foi substituído.

Example:

null