Skip to main content
POST
Inserir Previsão de Serviço
Campos obrigatórios ausentes ou inválidos retornam 400 com o detalhe em notifications/errors.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Previsão de faturamento de serviço recorrente ou único, usada para gerar automaticamente Notas Fiscais de Serviço em datas futuras. Recomenda-se validar em ambiente de testes antes do uso em produção.

codigoDaNotaFiscal
integer<int16>
required

Código do tipo/modelo de nota fiscal a ser gerado.

codigoDaFilial
integer<int16>
required

Código da filial.

codigoDoCliente
integer<int32>
required

Código do cliente.

codigoDoServico
integer<int32>
required

Código do serviço (CodigosDeServico).

valorDoServico
number
required

Valor do serviço a ser faturado em cada emissão.

periodoDeCompetencia
string<date-time> | null

Período de competência da previsão.

incluirPeriodoDeCompetenciaDescricao
boolean

Indica se o período de competência deve ser incluído na descrição do serviço na nota gerada.

dataDaProximaEmissao
string<date-time> | null

Data prevista para a próxima emissão.

dataDoProximoVencimento
string<date-time> | null

Data prevista do próximo vencimento.

frequencia
string | null

Frequência de recorrência da previsão (ex.: mensal, anual).

diasAntesDoProximoVencimento
integer<int16>

Quantidade de dias de antecedência para gerar a próxima emissão antes do vencimento.

numeroDeParcelas
integer<int16>

Número total de parcelas/emissões previstas, quando finita.

numeroDaProximaParcela
integer<int16>

Número da próxima parcela/emissão a ser gerada.

nomeDoCliente
string | null

Nome/razão social do cliente.

naturezaJuridica
string | null

Natureza jurídica do cliente.

paisExterior
boolean

Indica se o cliente está localizado no exterior.

codigoDoPais
integer<int32>

Código do país do cliente, quando no exterior.

idExterior
string | null

Identificação do cliente no exterior (equivalente ao CNPJ/CPF).

cnpjcpf
string | null

CNPJ ou CPF do cliente.

cep
string | null

CEP do cliente.

logradouro
string | null

Logradouro do endereço do cliente.

numero
string | null

Número do endereço do cliente.

complemento
string | null

Complemento do endereço do cliente.

bairro
string | null

Bairro do endereço do cliente.

cidade
string | null

Cidade do endereço do cliente.

uf
string | null

UF do endereço do cliente.

inscricaoEstadual
string | null

Inscrição Estadual do cliente.

inscricaoMunicipal
string | null

Inscrição Municipal do cliente.

telefone
string | null

Telefone de contato do cliente.

email
string | null

E-mail de contato do cliente.

codigoDoMunicipio
string | null

Código IBGE do município do cliente.

codigoDoMunicipioDePrestacaoDoServico
string | null

Código IBGE do município de prestação do serviço.

codigoDoItemDeLancamento
string | null

Código do item de lançamento de receita (Contas a Receber).

historicoCR
string | null

Histórico do lançamento de Contas a Receber.

codigoDaContaCorrente
integer<int16> | null

Código da conta corrente para recebimento.

codigoDaCarteira
integer<int16> | null

Código da carteira de cobrança.

codigoDoCentroDeCusto
string | null

Código do centro de custo.

codigoDoProjeto
integer<int32> | null

Código do projeto.

codigoDaClassificacaoAuxiliar
integer<int32> | null

Código da classificação auxiliar financeira.

codigoDoServicoPrestado
string | null

Código do serviço prestado (lista LC 116 / item municipal).

descricaoDoServico
string | null

Descrição do serviço prestado.

valorDaDeducao
number

Valor de deduções sobre o serviço, permitido pela legislação municipal.

aliquotaISSRetido
number

Alíquota do ISS retido na fonte.

valorINSSRetido
number

Valor do INSS retido.

codigoDaCondicaoDePagamento
integer<int32> | null

Código da condição de pagamento aplicada.

codigoDaFormaDePagamento
integer<int16> | null

Código da forma de pagamento.

dadosAdicionais
string | null

Informações complementares impressas na nota fiscal gerada.

codigoDoVendedor
integer<int32> | null

Código do vendedor responsável.

dataDeReajuste
string<date-time> | null

Data prevista para o próximo reajuste de valor.

informacoesDoReajuste
string | null

Informações sobre o índice/percentual de reajuste aplicável.

Response

Sucesso.

success
boolean
Example:

true

data
object

Previsão de faturamento de serviço recorrente ou único, usada para gerar automaticamente Notas Fiscais de Serviço em datas futuras. Recomenda-se validar em ambiente de testes antes do uso em produção.