Documentação das APIs

Insere um produto

Esta API permite a inclusão de um novo produto ou serviço.

Requisição

CampoTipoDescrição
IdNuméricoIdentificador único do produto(opcional)
NomeTextoNome do produto, máximo 255 posições
TiposTextoTipo do produto avulso ou assinatura(opcional)
MultaNuméricoPorcentagem da multa colocada no produto(opcional)
JurosMesNuméricoPorcentagem dos juros por mês(opcional)
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimento(opcional)
NotificacaoCobrancaDiasNuméricoDias antes do vencimento da cobrança para enviar a notificação(opcional)
NotificacaoCobrancaEmailBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via e-mail(opcional)
NotificacaoCobrancaSMSBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via SMS(opcional)
NotificacaoCobrancaCartaImpressaBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via carta(opcional)
PrimeiraTentativaHabilitadaBoleanoPrimeira tentativa de notificação com os dias vencidos(opcional)
PrimeiraTentativaDiasNuméricoNúmero de dias vencidos(opcional)
PrimeiraTentativaEmailBoleanoPrimeira tentativa de notificação com os dias vencidos via e-mail(opcional)
PrimeiraTentativaSMSBoleanoPrimeira tentativa de notificação com os dias vencidos via SMS(opcional)
SegundaTentativaHabilitadaBoleanoSegunda tentativa de notificação com os dias vencidos(opcional)
SegundaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
SegundaTentativaEmailBoleanoSegunda tentativa de notificação com os dias vencidos via e-mail(opcional)
SegundaTentativaSMSBoleanoSegunda tentativa de notificação com os dias vencidos via SMS(opcional)
TerceiraTentativaHabilitadaBoleanoTerceira tentativa de notificação com os dias vencidos(opcional)
TerceiraTentativaDiasNuméricoNúmero de dias vencidos(opcional)
TerceiraTentativaEmailBoleanoTerceira tentativa de notificação com os dias vencidos via e-mail(opcional)
TerceiraTentativaSMSBoleanoTerceira tentativa de notificação com os dias vencidos via SMS(opcional)
QuartaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
QuartaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
QuartaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
QuartaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
QuintaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
QuintaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
QuintaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
QuintaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
SextaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
SextaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
SextaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
SextaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
SetimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
SetimaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
SetimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
SetimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
OitavaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
OitavaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
OitavaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
OitavaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
NonaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
NonaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
NonaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
NonaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
DecimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
DecimaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
DecimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
DecimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)

Resposta

CampoTipoDescrição
IdNuméricoIdentificador único do produto
NomeTextoNome do produto , máximo 255 posições
TiposTextoTipo do produto avulso ou assinatura
MultaNuméricoPorcentagem da multa colocada no produto
JurosMesNuméricoPorcentagem dos juros por mês
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimento
NotificacaoCobrancaDiasNuméricoDias antes do vencimento da cobrança para enviar a notificação
NotificacaoCobrancaEmailBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via e-mail
NotificacaoCobrancaSMSBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via SMS
NotificacaoCobrancaCartaImpressaBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via carta
PrimeiraTentativaHabilitadaBoleanoPrimeira tentativa de notificação com os dias vencidos
PrimeiraTentativaDiasNuméricoNúmero de dias vencidos
PrimeiraTentativaEmailBoleanoPrimeira tentativa de notificação com os dias vencidos via e-mail
PrimeiraTentativaSMSBoleanoPrimeira tentativa de notificação com os dias vencidos via SMS
SegundaTentativaHabilitadaBoleanoSegunda tentativa de notificação com os dias vencidos
SegundaTentativaDiasNuméricoNúmero de dias vencidos
SegundaTentativaEmailBoleanoSegunda tentativa de notificação com os dias vencidos via e-mail
SegundaTentativaSMSBoleanoSegunda tentativa de notificação com os dias vencidos via SMS
TerceiraTentativaHabilitadaBoleanoTerceira tentativa de notificação com os dias vencidos
TerceiraTentativaDiasNuméricoNúmero de dias vencidos
TerceiraTentativaEmailBoleanoTerceira tentativa de notificação com os dias vencidos via e-mail
TerceiraTentativaSMSBoleanoTerceira tentativa de notificação com os dias vencidos via SMS
QuartaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
QuartaTentativaDiasNuméricoNúmero de dias vencidos
QuartaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
QuartaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
QuintaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
QuintaTentativaDiasNuméricoNúmero de dias vencidos
QuintaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
QuintaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
SextaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
SextaTentativaDiasNuméricoNúmero de dias vencidos
SextaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
SextaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
SetimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
SetimaTentativaDiasNuméricoNúmero de dias vencidos
SetimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
SetimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
OitavaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
OitavaTentativaDiasNuméricoNúmero de dias vencidos
OitavaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
OitavaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
NonaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
NonaTentativaDiasNuméricoNúmero de dias vencidos
NonaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
NonaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
DecimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
DecimaTentativaDiasNuméricoNúmero de dias vencidos
DecimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
DecimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!