Skip to main content

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.
documento_fiscal.serie_contador
Número do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
documento_fiscal.serie_codigo
Código do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
modalidades[].id
Código da modalidade de pagamento.
modalidades[].identificacao
Identificação da modalidade de pagamento.
modalidades[].valor
Valor pago através da modalidade de pagamento.
tag_externa
Identificador do integrador.

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",
        "documento_fiscal": {
          "serie_contador": 1233333,
          "serie_codigo": "A"          
        },
        "tag_externa": "ABCDEF0123456789",
        "modalidades": [
          {
            "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
            "identificacao": "DÉBITO",
            "valor": 100.5
          }
        ]
    }
}

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.