v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Produto

Atualiza um produto

Esta API permite a atualização de um novo produto por ID.

Requisição

CampoTipoDescriçãoObrigatório
IdGUIDIdentificador único do produtoSim
NomeTextoNome do produto, máximo 255 posiçõesSim
TiposTextoTipo do produto avulso ou assinaturaNão
MultaNuméricoPorcentagem da multa colocada no produtoNão
JurosMesNuméricoPorcentagem dos juros por mêsNão
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimentoNão
NotificacaoCobrancaDiasNuméricoDias antes do vencimento da cobrança para enviar a notificaçãoNão
NotificacaoCobrancaEmailBooleanoSe esta opção estiver marcada, o cliente receberá uma notificação via e-mailNão
NotificacaoCobrancaSMSBooleanoSe esta opção estiver marcada, o cliente receberá uma notificação via SMSNão
NotificacaoCobrancaCartaImpressaBooleanoSe esta opção estiver marcada, o cliente receberá uma notificação via cartaNão
PrimeiraTentativaHabilitadaBooleanoPrimeira tentativa de notificação com os dias vencidosNão
PrimeiraTentativaDiasNuméricoNúmero de dias vencidosNão
PrimeiraTentativaEmailBooleanoPrimeira tentativa de notificação com os dias vencidos via e-mailNão
PrimeiraTentativaSMSBooleanoPrimeira tentativa de notificação com os dias vencidos via SMSNão
SegundaTentativaHabilitadaBooleanoSegunda tentativa de notificação com os dias vencidosNão
SegundaTentativaDiasNuméricoNúmero de dias vencidosNão
SegundaTentativaEmailBooleanoSegunda tentativa de notificação com os dias vencidos via e-mailNão
SegundaTentativaSMSBooleanoSegunda tentativa de notificação com os dias vencidos via SMSNão
TerceiraTentativaHabilitadaBooleanoTerceira tentativa de notificação com os dias vencidosNão
TerceiraTentativaDiasNuméricoNúmero de dias vencidosNão
TerceiraTentativaEmailBooleanoTerceira tentativa de notificação com os dias vencidos via e-mailNão
TerceiraTentativaSMSBooleanoTerceira tentativa de notificação com os dias vencidos via SMSNão
QuartaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
QuartaTentativaDiasNuméricoNúmero de dias vencidosNão
QuartaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
QuartaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
QuintaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
QuintaTentativaDiasNuméricoNúmero de dias vencidosNão
QuintaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
QuintaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
SextaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
SextaTentativaDiasNuméricoNúmero de dias vencidosNão
SextaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
SextaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
SetimaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
SetimaTentativaDiasNuméricoNúmero de dias vencidosNão
SetimaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
SetimaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
OitavaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
OitavaTentativaDiasNuméricoNúmero de dias vencidosNão
OitavaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
OitavaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
NonaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
NonaTentativaDiasNuméricoNúmero de dias vencidosNão
NonaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
NonaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
DecimaTentativaHabilitadaBooleanoQuarta tentativa de notificação com os dias vencidosNão
DecimaTentativaDiasNuméricoNúmero de dias vencidosNão
DecimaTentativaEmailBooleanoQuarta tentativa de notificação com os dias vencidos via e-mailNão
DecimaTentativaSMSBooleanoQuarta tentativa de notificação com os dias vencidos via SMSNão
put/api/Produto

Headers

Aeskeystring required

Request body

Idstring

Id do produto

Nomestring required

Nome do produto, máximo 255 posições

Tipos'Todos' | 'Avulsa' | 'Assinatura' | 'Link' | 'Carne'

Tipos de cobrança do produto, pode combinar os valores

Multanumber double

Valor percentual da multa

JurosMesnumber double

Valor percentual do juros ao mês

DescontoAteVencimentonumber double

Valor percentual do desconto até a data de vencimento

NotificacaoCobrancaDiasinteger

Dias antes do vencimento para notificar

NotificacaoCobrancaEMailboolean

Notificação via EMail

NotificacaoCobrancaSMSboolean

Notificação via SMS

NotificacaoCobrancaCartaImpressaboolean

Notificação via Carta

PrimeiraTentativaHabilitadaboolean

Habilitado primeira tentativa em atraso

PrimeiraTentativaDiasinteger

Dias primeira tentativa em atraso

PrimeiraTentativaEMailboolean

Email da primeira tentativa em atraso

PrimeiraTentativaSMSboolean

SMS da primeira tentativa em atraso

SegundaTentativaHabilitadaboolean

Habilitado segunda tentativa em atraso

SegundaTentativaDiasinteger

Dias segunda tentativa em atraso

SegundaTentativaEMailboolean

Email da segunda tentativa em atraso

SegundaTentativaSMSboolean

SMS da segunda tentativa em atraso

TerceiraTentativaHabilitadaboolean

Habilitado terceira tentativa em atraso

TerceiraTentativaDiasinteger

Dias terceira tentativa em atraso

TerceiraTentativaEMailboolean

Email da terceira tentativa em atraso

TerceiraTentativaSMSboolean

SMS da terceira tentativa em atraso

QuartaTentativaHabilitadaboolean

Habilitado quarta tentativa em atraso

QuartaTentativaDiasinteger

Dias quarta tentativa em atraso

QuartaTentativaEMailboolean

Email da quarta tentativa em atraso

QuartaTentativaSMSboolean

SMS da quarta tentativa em atraso

QuintaTentativaHabilitadaboolean

Habilitado Quinta tentativa em atraso

QuintaTentativaDiasinteger

Dias Quinta tentativa em atraso

QuintaTentativaEMailboolean

Email da Quinta tentativa em atraso

QuintaTentativaSMSboolean

SMS da Quinta tentativa em atraso

SextaTentativaHabilitadaboolean

Habilitado Sexta tentativa em atraso

SextaTentativaDiasinteger

Dias Sexta tentativa em atraso

SextaTentativaEMailboolean

Email da Sexta tentativa em atraso

SextaTentativaSMSboolean

SMS da Sexta tentativa em atraso

SetimaTentativaHabilitadaboolean

Habilitado Setima tentativa em atraso

SetimaTentativaDiasinteger

Dias Setima tentativa em atraso

SetimaTentativaEMailboolean

Email da Setima tentativa em atraso

SetimaTentativaSMSboolean

SMS da Setima tentativa em atraso

OitavaTentativaHabilitadaboolean

Habilitado Oitava tentativa em atraso

OitavaTentativaDiasinteger

Dias Oitava tentativa em atraso

OitavaTentativaEMailboolean

Email da Oitava tentativa em atraso

OitavaTentativaSMSboolean

SMS da Oitava tentativa em atraso

NonaTentativaHabilitadaboolean

Habilitado Nona tentativa em atraso

NonaTentativaDiasinteger

Dias Nona tentativa em atraso

NonaTentativaEMailboolean

Email da Nona tentativa em atraso

NonaTentativaSMSboolean

SMS da Nona tentativa em atraso

DecimaTentativaHabilitadaboolean

Habilitado Decima tentativa em atraso

DecimaTentativaDiasinteger

Dias Decima tentativa em atraso

DecimaTentativaEMailboolean

Email da Decima tentativa em atraso

DecimaTentativaSMSboolean

SMS da Decima tentativa em atraso

Example request

{
  "Id": "87654321-8765-4321-8765-432187654321",
  "Nome": "Plano Premium Anual",
  "Tipos": "Assinatura",
  "Multa": 2,
  "JurosMes": 1,
  "DescontoAteVencimento": 5,
  "NotificacaoCobrancaDias": 5,
  "NotificacaoCobrancaEMail": true,
  "NotificacaoCobrancaSMS": true,
  "NotificacaoCobrancaCartaImpressa": false,
  "PrimeiraTentativaHabilitada": true,
  "PrimeiraTentativaDias": 3,
  "PrimeiraTentativaEMail": true,
  "PrimeiraTentativaSMS": true,
  "SegundaTentativaHabilitada": true,
  "SegundaTentativaDias": 7,
  "SegundaTentativaEMail": true,
  "SegundaTentativaSMS": true,
  "TerceiraTentativaHabilitada": true,
  "TerceiraTentativaDias": 14,
  "TerceiraTentativaEMail": true,
  "TerceiraTentativaSMS": true,
  "QuartaTentativaHabilitada": true,
  "QuartaTentativaDias": 21,
  "QuartaTentativaEMail": true,
  "QuartaTentativaSMS": false,
  "QuintaTentativaHabilitada": true,
  "QuintaTentativaDias": 30,
  "QuintaTentativaEMail": true,
  "QuintaTentativaSMS": false,
  "SextaTentativaHabilitada": false,
  "SextaTentativaDias": 0,
  "SextaTentativaEMail": false,
  "SextaTentativaSMS": false,
  "SetimaTentativaHabilitada": false,
  "SetimaTentativaDias": 0,
  "SetimaTentativaEMail": false,
  "SetimaTentativaSMS": false,
  "OitavaTentativaHabilitada": false,
  "OitavaTentativaDias": 0,
  "OitavaTentativaEMail": false,
  "OitavaTentativaSMS": false,
  "NonaTentativaHabilitada": false,
  "NonaTentativaDias": 0,
  "NonaTentativaEMail": false,
  "NonaTentativaSMS": false,
  "DecimaTentativaHabilitada": false,
  "DecimaTentativaDias": 0,
  "DecimaTentativaEMail": false,
  "DecimaTentativaSMS": false
}

Response

OK

object required