v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBProduto
Consulta o produto por id
Esta API permite consultar um produto por ID.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador único do produto | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | GUID | Identificador único do produto |
| Nome | Texto | Nome do produto, máximo 255 posições |
| Tipos | Texto | Tipo do produto avulso ou assinatura |
| Multa | Numérico | Porcentagem da multa colocada no produto |
| JurosMes | Numérico | Porcentagem dos juros por mês |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento |
| NotificacaoCobrancaDias | Numérico | Dias antes do vencimento da cobrança para enviar a notificação |
| NotificacaoCobrancaEmail | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via e-mail |
| NotificacaoCobrancaSMS | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via SMS |
| NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via carta |
| PrimeiraTentativaHabilitada | Booleano | Primeira tentativa de notificação com os dias vencidos |
| PrimeiraTentativaDias | Numérico | Número de dias vencidos |
| PrimeiraTentativaEmail | Booleano | Primeira tentativa de notificação com os dias vencidos via e-mail |
| PrimeiraTentativaSMS | Booleano | Primeira tentativa de notificação com os dias vencidos via SMS |
| SegundaTentativaHabilitada | Booleano | Segunda tentativa de notificação com os dias vencidos |
| SegundaTentativaDias | Numérico | Número de dias vencidos |
| SegundaTentativaEmail | Booleano | Segunda tentativa de notificação com os dias vencidos via e-mail |
| SegundaTentativaSMS | Booleano | Segunda tentativa de notificação com os dias vencidos via SMS |
| TerceiraTentativaHabilitada | Booleano | Terceira tentativa de notificação com os dias vencidos |
| TerceiraTentativaDias | Numérico | Número de dias vencidos |
| TerceiraTentativaEmail | Booleano | Terceira tentativa de notificação com os dias vencidos via e-mail |
| TerceiraTentativaSMS | Booleano | Terceira tentativa de notificação com os dias vencidos via SMS |
| QuartaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| QuartaTentativaDias | Numérico | Número de dias vencidos |
| QuartaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuartaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| QuintaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| QuintaTentativaDias | Numérico | Número de dias vencidos |
| QuintaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuintaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| SextaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| SextaTentativaDias | Numérico | Número de dias vencidos |
| SextaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| SextaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| SetimaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| SetimaTentativaDias | Numérico | Número de dias vencidos |
| SetimaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| SetimaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| OitavaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| OitavaTentativaDias | Numérico | Número de dias vencidos |
| OitavaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| OitavaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| NonaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| NonaTentativaDias | Numérico | Número de dias vencidos |
| NonaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| NonaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| DecimaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| DecimaTentativaDias | Numérico | Número de dias vencidos |
| DecimaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| DecimaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
get/api/Produto/{Id}
Path parameters
Idstring required
Id do produto
Headers
Aeskeystring required
Response
Produto consultado
Example response
{
"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
}