v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar pagamento de parcelas de propostas

get/proposalParcelPayments

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima página.

sortstring

Critérios de ordenação (ASC / DESC).

idinteger

Filtrar pelo ID do pagamento de parcela da proposta.

proposal_parcel_idinteger

Filtrar pelo ID da parcela da proposta.

valuenumber float

Filtrar pelo valor da parcela da proposta.

commission_valuenumber float

Filtrar pelo valor da comissão da parcela da proposta.

paid_at_startstring date

Filtrar pelo pagamento de parcela de proposta realizada a partir da data e hora informada.

paid_at_endstring

Filtrar pelo pagamento de parcela de proposta realizada até a data e hora informada.

created_at_startstring

Filtrar pelo pagamento de parcela de proposta criado a partir da data e hora informada.

created_at_endstring

Filtrar pelo pagamento de parcela de proposta criado até a data e hora informada.

updated_at_startstring

Filtrar pelo pagamento de parcela de proposta atualizado a partir da data e hora informada.

updated_at_endstring

Filtrar pelo pagamento de parcela de proposta atualizado até a data e hora informada.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 748,
      "account_id": 748,
      "proposal_id": 748,
      "proposal_parcel_id": 748,
      "value": 1,
      "commission_value": 1,
      "paid_at": "2020-03-28",
      "created_at": "2020-03-28",
      "updated_at": "2020-03-28"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6MjUyODM0....h0SXRlbXMiOnRydWV9"
    }
  }
}