Sign in

v1

latestOpenAPI 3.1.02026-08-041420513.7 KB

Agendar recebimento

Cria agendamento de recebimento, com a possibilidade de automatizar a emissão de boletos e notas fiscais, além de permitir a criação de agendamentos com recorrência ou parcelamento.

post/v1/schedules/credit

Request body

stakeholderIdstring required

Identificador do contato (cliente ou sócio)

scheduleDatestring required

Data prevista para o recebimento

dueDatestring required

Data de vencimento do agendamento

costCenterValueTypeinteger

Tipo de valor do centro de custo (0 para valor, 1 para porcentagem).

accrualDatestring

Data da competência

descriptionstring

Descrição do agendamento

referencestring

Descrição da referência

isFlaggedboolean

Habilitar agendamento como favorito

serviceProfileIdstring

Identificador do perfil de serviço

additionalRemarksstring

Informações complementares

additionalServiceDescriptionstring

Descrição do serviço

stateWhereServiceWasProvidedstring

Estado da prestação de serviço em outro município

cityWhereServiceWasProvidedstring

Cidade da prestação de serviço em outro município

autoGenerateNFSeTypeinteger

2=Dias antes do vencimento, 3=Quando a baixa for realizada, 4= Quando boleto for criado, 5=enviar imediatamente

daysBeforeDueDateToGenerateNFSeinteger

Define a quantidade de dias dias antes da data de vencimento para gerar a nota fiscal.

Response

200

object required