Listar faturas da apólice

Esse método retorna uma lista paginada com todas as faturas de uma apólice específica.

GET{{api_url}}/api/v1/policy-charges/${id}

Headers

Name
Type
Description

Authorization*

String

Código de acesso

Response Body

Name
Type
Description

findCharge.id_client

Number

Identificador único do cliente

findCharge.status

String

Status da fatura

created_at

Date

Data de criação da fatura

invoice_number

String

Tipo da fatura

payment_date

Date

Data de pagamento da fatura

form_payment

String

Método de pagamento

bandeira_cartao

String

Bandeira do cartão de crédito

digitos_cartao

String

Últimos digítos do cartão de crédito

invoice_link

String

Link da fatura

link_boleto

String

Link do boleto

id_invoice

Number

Identificador único da fatura

Response Examples

{
    "findCharge": [
        {
            "id_client": 4169,
            "status": "paid",
            "invoice_number": null,
            "created_at": "2024-04-11",
            "payment_date": "2024-04-12",
            "form_payment": "billet",
            "bandeira_cartao": null,
            "digitoscartao": null,
            "invoice_link": null,
            "link_boleto": null,
            "id_invoice": 756
        }
    ]
}

Last updated