v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Proposal

Find proposals by query filters.

Retrieve proposals based on query parameters

Recuperar propostas com base nos parâmetros de consulta

get/proposals

Query parameters

offer_idinteger required

ID of the offer from which the proposal was made

ID da oferta que foi feita a proposta

company_idinteger

ID of the company that made the proposal

ID da company que fez a proposta

statusstring

Status of the proposal (AVAILABLE, APPROVED, CANCELED)

Status da proposta (DISPONÍVEL, APROVADO, CANCELADO)

currencystring

Currency type of the offer (Ex: BRL)

Tipo da moeda (Ex: BRL)

limitinteger

Limit of objects in a page of the pagination

Limite de objeto em uma página da paginação

pageinteger

Page of the pagination, return the amount of objects that was set in the limit

Página da paginação, retorna o total de objetos setado no limite

created_greater_or_equal_thanstring

Created date greater or equal to (YYYY-MM-DD)

Data de criação maior ou igual a (AAAA-MM-DD)

created_less_or_equal_thanstring

Created date less or equal to (YYYY-MM-DD)

Data de criação menor ou igual a (AAAA-MM-DD)

Response

List of users matching the filters | Lista de usuários que correspondem aos filtros

limitinteger

pageinteger

sortstring

total_pagesinteger

total_rowsinteger

Example response

{
  "limit": 10,
  "page": 1,
  "rows": [
    {
      "accepted_at": "2024-09-06T17:37:43.464658136Z",
      "company_id": 1,
      "contract_id": 1,
      "created_at": "2020-01-01 12:00:00",
      "currency": "BRL",
      "id": 1,
      "offer_id": 1,
      "proposal_value": 100,
      "status": "AVAILABLE",
      "updated_at": "2020-01-01 12:00:00",
      "user_id": 1
    }
  ],
  "sort": "created_at desc",
  "total_pages": 1,
  "total_rows": 1
}