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 recorrentes
        • POSTCriar receita recorrente
        • PUTAtualizar receita recorrente
        • POSTCancelar receita recorrente
  • Entrada pública de leads
LogoLogo
Integrações privadasFinanceiroReceitas recorrentes

Criar receita recorrente

||View as Markdown|
POST
/simplificav2/receita_recorrente
POST
/ords/gestao/simplificav2/receita_recorrente
$curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/receita_recorrente \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "conta_bancaria_id": 3,
>  "categoria_id": 41,
>  "tipo_pagamento_id": 9,
>  "nome": "Mensalidade Premium",
>  "valor": 350,
>  "data_inicio": "2026-04-10",
>  "frequencia": "MENSAL",
>  "qtd_prevista": 12,
>  "pessoa_id": 164272,
>  "centro_custo_id": 12,
>  "descricao": "Série mensal criada pela integração.",
>  "pagar_retroativos": "N"
>}'
1{
2  "status": "sucesso",
3  "mensagem": "Receita recorrente criada com sucesso.",
4  "data": {
5    "id": 227
6  }
7}
Cria uma nova recorrência de receita. Regras: - informe conta bancária, categoria, tipo de pagamento, nome, valor, data de início, frequência e quantidade prevista; - `pessoa_id`, `centro_custo_id` e `descricao` são opcionais; - `pagar_retroativos` aceita `S` ou `N`; - `frequencia` aceita `SEMANAL`, `QUINZENAL`, `MENSAL`, `SEMESTRAL` ou `ANUAL`; - o valor precisa ser maior que zero.
Was this page helpful?
Previous

Listar receitas recorrentes

Next

Atualizar receita recorrente

Built with

Cria uma nova recorrência de receita.

Regras:

  • informe conta bancária, categoria, tipo de pagamento, nome, valor, data de início, frequência e quantidade prevista;
  • pessoa_id, centro_custo_id e descricao são opcionais;
  • pagar_retroativos aceita S ou N;
  • frequencia aceita SEMANAL, QUINZENAL, MENSAL, SEMESTRAL ou ANUAL;
  • o valor precisa ser maior que zero.

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.

Request

This endpoint expects an object.
conta_bancaria_idintegerRequired
categoria_idintegerRequired
tipo_pagamento_idintegerRequired
nomestringRequired<=200 characters
valordoubleRequired
data_iniciodateRequired
frequenciaenumRequired
Allowed values:
qtd_previstaintegerRequired>=1
pessoa_idinteger or nullOptional
centro_custo_idinteger or nullOptional
descricaostring or nullOptional<=4000 characters
pagar_retroativosenumOptional
Allowed values:

Response

Receita recorrente criada com sucesso.
statusstring
mensagemstring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity 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.