For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentaçãoReferência da API
DocumentaçãoReferência da API
  • Integrações privadas
        • GETListar receitas parceladas
        • POSTCriar receita parcelada
        • PUTAtualizar receita parcelada
        • POSTCancelar receita parcelada
  • Entrada pública de leads
LogoLogo
Integrações privadasFinanceiroReceitas parceladas

Listar receitas parceladas

||View as Markdown|
GET
/simplificav2/receita_parcelada
GET
/ords/gestao/simplificav2/receita_parcelada
$curl https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/receita_parcelada \
>     -H "Authorization: Bearer <token>"
1{
2  "count": 1,
3  "hasMore": true,
4  "limit": 1,
5  "offset": 1,
6  "items": [
7    {
8      "id": 1,
9      "conta_bancaria_id": 1,
10      "categoria_id": 1,
11      "tipo_pagamento_id": 1,
12      "pessoa_id": 1,
13      "centro_custo_id": 1,
14      "receita_principal_id": 1,
15      "nome": "string",
16      "descricao": "string",
17      "valor_total": 1.1,
18      "qtd_parcelas": 1,
19      "valor_parcela": 1.1,
20      "frequencia": "string",
21      "data_inicio": "string",
22      "data_fim": "string",
23      "status": "string",
24      "asaas_customer_id": "string",
25      "asaas_installment_id": "string",
26      "asaas_status": "string",
27      "ativo": "string",
28      "empresa_id": 1,
29      "criado_em": "string",
30      "criado_por": "string",
31      "alterado_em": "string",
32      "alterado_por": "string"
33    }
34  ],
35  "links": [
36    {
37      "rel": "string",
38      "href": "string"
39    }
40  ]
41}
Retorna as receitas parceladas cadastradas para a empresa autenticada. Uso comum: - consultar parcelamentos a receber; - acompanhar desdobramentos financeiros de uma mesma origem; - alimentar integrações de cobrança parcelada. Exemplo de uso: ```http GET {{base_url}}/simplificav2/receita_parcelada?limit={{limit}} Authorization: Bearer {{bearer_token}} Accept: application/json ```
Was this page helpful?
Previous

Cancelar receita recorrente

Next

Criar receita parcelada

Built with

Retorna as receitas parceladas cadastradas para a empresa autenticada.

Uso comum:

  • consultar parcelamentos a receber;
  • acompanhar desdobramentos financeiros de uma mesma origem;
  • alimentar integrações de cobrança parcelada.

Exemplo de uso:

1GET {{base_url}}/simplificav2/receita_parcelada?limit={{limit}}
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Authentication

AuthorizationBearer
Token privado usado para consultar dados da plataforma. Como usar: - obtenha o token privado da sua empresa; - envie `Authorization: Bearer SEU_TOKEN_PRIVADO`; - não use `x-api-key` neste módulo.

Query parameters

offsetintegerOptional>=0

Quantos registros pular antes de começar a resposta.

limitintegerOptional>=1
Quantidade máxima de registros por resposta. Observação: - informe `limit` explicitamente quando quiser controlar a quantidade por resposta.
qstringOptional
Filtro opcional para restringir, combinar ou ordenar os resultados. Se você não enviar `q`, o endpoint retorna a listagem padrão daquele recurso. Quando precisar filtrar, o `q` recebe um JSON no padrão FilterObject do ORDS. Regras práticas: - comece testando o endpoint sem filtro; - use os nomes de coluna publicados naquele endpoint; - use sempre o nome do campo exatamente como ele aparece no schema do endpoint; - `offset` e `limit` não entram dentro do `q`; - em clientes HTTP fora do Postman, o conteúdo normalmente precisa ser enviado URL-encoded; - no Postman, prefira informar o valor na aba `Params`. Operadores úteis: - `$or` - `$between` - `$orderby` - `$date` - `$ne`, `$lt`, `$lte`, `$gt`, `$gte` - `$instr`, `$ninstr` - `$notnull` Exemplos legíveis: - `{"id":162472}` - `{"ativo":"S"}` - `{"receita_recorrente_id":{"$notnull":null}}` - `{"status":"ABERTO","$orderby":{"data_vencimento":"ASC"}}` - `{"criado_em":{"$between":[{"$date":"2026-03-01T00:00:00Z"},{"$date":"2026-03-31T23:59:59Z"}]}}` Os mesmos exemplos prontos para URL: - `%7B%22id%22%3A162472%7D` - `%7B%22ativo%22%3A%22S%22%7D` - `%7B%22receita_recorrente_id%22%3A%7B%22%24notnull%22%3Anull%7D%7D` - `%7B%22status%22%3A%22ABERTO%22%2C%22%24orderby%22%3A%7B%22data_vencimento%22%3A%22ASC%22%7D%7D` - `%7B%22criado_em%22%3A%7B%22%24between%22%3A%5B%7B%22%24date%22%3A%222026-03-01T00%3A00%3A00Z%22%7D%2C%7B%22%24date%22%3A%222026-03-31T23%3A59%3A59Z%22%7D%5D%7D%7D`

Response

Coleção paginada de receitas parceladas.

countinteger
hasMoreboolean
limitinteger
offsetinteger
itemslist of objects
linkslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error

Token privado usado para consultar dados da plataforma.

Como usar:

  • obtenha o token privado da sua empresa;
  • envie Authorization: Bearer SEU_TOKEN_PRIVADO;
  • não use x-api-key neste módulo.

Quantidade máxima de registros por resposta.

Observação:

  • informe limit explicitamente quando quiser controlar a quantidade por resposta.

Filtro opcional para restringir, combinar ou ordenar os resultados.

Se você não enviar q, o endpoint retorna a listagem padrão daquele recurso.

Quando precisar filtrar, o q recebe um JSON no padrão FilterObject do ORDS.

Regras práticas:

  • comece testando o endpoint sem filtro;
  • use os nomes de coluna publicados naquele endpoint;
  • use sempre o nome do campo exatamente como ele aparece no schema do endpoint;
  • offset e limit não entram dentro do q;
  • em clientes HTTP fora do Postman, o conteúdo normalmente precisa ser enviado URL-encoded;
  • no Postman, prefira informar o valor na aba Params.

Operadores úteis:

  • $or
  • $between
  • $orderby
  • $date
  • $ne, $lt, $lte, $gt, $gte
  • $instr, $ninstr
  • $notnull

Exemplos legíveis:

  • {"id":162472}
  • {"ativo":"S"}
  • {"receita_recorrente_id":{"$notnull":null}}
  • {"status":"ABERTO","$orderby":{"data_vencimento":"ASC"}}
  • {"criado_em":{"$between":[{"$date":"2026-03-01T00:00:00Z"},{"$date":"2026-03-31T23:59:59Z"}]}}

Os mesmos exemplos prontos para URL:

  • %7B%22id%22%3A162472%7D
  • %7B%22ativo%22%3A%22S%22%7D
  • %7B%22receita_recorrente_id%22%3A%7B%22%24notnull%22%3Anull%7D%7D
  • %7B%22status%22%3A%22ABERTO%22%2C%22%24orderby%22%3A%7B%22data_vencimento%22%3A%22ASC%22%7D%7D
  • %7B%22criado_em%22%3A%7B%22%24between%22%3A%5B%7B%22%24date%22%3A%222026-03-01T00%3A00%3A00Z%22%7D%2C%7B%22%24date%22%3A%222026-03-31T23%3A59%3A59Z%22%7D%5D%7D%7D