Consulta faturamento de contrato de plano
Consulta faturamento de contrato de plano através do plano_contrato_faturamento_id
GET api/planos_contratos_faturamentos/<plano_contrato_faturamento_id>
HEADERS
CHAVE |
VALOR |
DESCRIÇÃO |
OBRIGATÓRIO |
Accept |
application/vnd.linkc.com.br; version=1 | Versão da API. | SIM |
Authorization |
Bearer <TOKEN> |
Token obtido na autenticação |
SIM |
Content-Type |
application/json |
Tipo de conteúdo do request |
SIM |
RETORNO EM CASO DE SUCESSO (200 – OK)
CHAVE |
DESCRIÇÃO |
id
|
Código do faturamento de contrato de plano.
|
plano_contrato_id
|
Código do contrato de plano
|
valor
|
Valor pago.
|
registrado_em
|
Data e hora do registro de pagamento.
|
cartao_credito_token
|
Token do cartão de crédito para futuros pagamentos. O token não fica armazenado na API e não pode ser consultado novamente.
|
documento_fiscal_numero
|
Número do documento fiscal gerado na garagem.
|
EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)
{
"plano_contrato_faturamento": {
"id": "ebc471e3-aed6-47d7-a76c-758c335deb05",
"plano_contrato_id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
"valor": 100.5,
"registrado_em": "2019-08-30T18:35:25.000-03:00",
"cartao_credito_token": "db62dc71-d07b-4745-9969-42697b988ccb",
"documento_fiscal_numero": "123456"
}
}
OUTROS RETORNOS
CÓDIGO HTTP |
DESCRIÇÃO |
401
|
Caso as credenciais sejam inválidas.
|
404
|
Caso o código do faturamento de contrato de plano não seja encontrado na garagem.
|
502
|
Caso não seja possível realizar comunicação com a automação da garagem.
|