Skip to navigation
Integrações privadasFinanceiroReceitas recorrentes

Criar receita recorrente

View as Markdown

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