Skip to main content
GET
Get proposal
Draft: specification in progress. Endpoints and fields may change.

Authorizations

Authorization
string
header
required

The organization's API key (tesa_live_... in production, tesa_test_... in the sandbox).

Path Parameters

id
string
required

Proposal identifier, prefixed with prop_.

Example:

"prop_8f2a1c"

Response

Proposal.

id
string
Example:

"prop_8f2a1c"

tipo
enum<string>
Available options:
alocacao,
rebalanceamento
status
enum<string>
Available options:
pendente,
aprovada,
rejeitada,
executada
origem
enum<string>

regra: generated by a rule in the company's policy. manual: created by the company with POST /propostas.

Available options:
regra,
manual
regra_id
string | null

Policy rule that generated the proposal, when origem is regra.

motivo
string
movimentos
object[]
alocacao_resultante
object[]
transacoes
object[]

Available from the aprovada status onward.

criada_em
string<date-time>
decidida_em
string<date-time> | null
executada_em
string<date-time> | null