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

Atualizar receita recorrente

||View as Markdown|
PUT
/simplificav2/receita_recorrente/:id
PUT
/ords/gestao/simplificav2/receita_recorrente/:id
$curl -X PUT https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/receita_recorrente/1 \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "motivo": "string"
>}'
1{
2  "status": "sucesso",
3  "mensagem": "Receita recorrente atualizada com sucesso.",
4  "data": {
5    "id": 227
6  }
7}
Ajusta uma recorrência de receita existente. Regras: - a operação atualiza somente os campos enviados; - campos omitidos continuam com o valor atual; - informe `motivo` em todo ajuste; - `aplicar_em` aceita `FUTURAS` ou `PROXIMAS`; - a data de início e a frequência não são alteradas por esta rota; - em recorrências já integradas, a alteração fica restrita aos campos operacionais permitidos.
Was this page helpful?
Previous

Criar receita recorrente

Next

Cancelar receita recorrente

Built with

Ajusta uma recorrência de receita existente.

Regras:

  • a operação atualiza somente os campos enviados;
  • campos omitidos continuam com o valor atual;
  • informe motivo em todo ajuste;
  • aplicar_em aceita FUTURAS ou PROXIMAS;
  • a data de início e a frequência não são alteradas por esta rota;
  • em recorrências já integradas, a alteração fica restrita aos campos operacionais permitidos.

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.

Path parameters

idintegerRequired
Identificador da receita recorrente.

Request

This endpoint expects an object.
motivostringRequired<=4000 characters
valordouble or nullOptional
nomestring or nullOptional<=200 characters
descricaostring or nullOptional<=4000 characters
centro_custo_idinteger or nullOptional
conta_bancaria_idinteger or nullOptional
categoria_idinteger or nullOptional
tipo_pagamento_idinteger or nullOptional
aplicar_emenumOptional
Allowed values:

Response

Receita recorrente atualizada com sucesso.
statusstring
mensagemstring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found 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.