List bills

GET

GET https://platform-api.lia.com.br/external_api/v1/bills

Body params

Name	Description	Required	Type
billing_id	Filter by bill’s billing id	false	String
status	Filter by bill’s status: pending, paid or canceled	false	String
due_date_start	Filter by bill’s due date greater than or equal to (YYYY-MM-DD)	false	String
due_date_end	Filter by bill’s due date lesser than or equal to (YYYY-MM-DD)	false	String
paid_at_start	Filter by bill’s payment date greater than or equal to (YYYY-MM-DD)	false	String
paid_at_end	Filter by bill’s payment date lesser than or equal to (YYYY-MM-DD)	false	String
page	Number of the page you want	false	Integer
per_page	Total items per page, max 1000 items per page	false	Integer

Example request

curl --location 'https://platform-api-sandbox.lia.com.br/external_api/v1/bills?status=paid&page=1&per_page=2' \
--header 'Authorization: Bearer token'

Example response

{
  "results": [
    {
      "amount_cents": 3591,
      "authentication_code": "2bbb59ba23478328e5bc806e9ddfe0b2",
      "bill_type": "down_payment",
      "billing": {
        "amount_cents": 31807,
        "amount_currency": "BRL",
        "cancelation_reason": null,
        "created_at": "2023-09-05T18:33:30.770-03:00",
        "due_day": 20,
        "finished_at": null,
        "id": "7edb6396-a4f3-41e6-b577-47aee2e0eaed",
        "installments": 3,
        "order_id": "b2d40390-5747-4ad8-835c-26d29ddaad52",
        "origin_billing_id": null,
        "status": "active",
        "updated_at": "2024-07-19T17:00:25.389-03:00"
      },
      "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=263a8428-8602-4297-8272-531622a64cec",
      "created_at": "2023-09-05T18:33:30.782-03:00",
      "current_amount_cents": 3591,
      "disable_penalties_until": null,
      "due_date": "2023-09-07T23:59:59.999-03:00",
      "effective_due_date": "2023-09-08T23:59:59.999-03:00",
      "id": "263a8428-8602-4297-8272-531622a64cec",
      "original_amount_cents": 3591,
      "paid_at": "2023-09-05T18:33:31.706-03:00",
      "payments": [
        {
          "amount_cents": 3591,
          "barcode": null,
          "barcode_image_url": null,
          "bill_id": "263a8428-8602-4297-8272-531622a64cec",
          "created_at": "2023-09-05T18:33:31.626-03:00",
          "expires_at": "2023-09-07T23:59:59.999-03:00",
          "id": "ff1f6afd-681f-4f9a-8a42-1f6c56d802ea",
          "installments": 1,
          "paid_amount_cents": 3591,
          "paid_at": "2023-09-05T18:33:31.637-03:00",
          "payment_method": "credit_card",
          "refunded_amount_cents": 0,
          "refunded_at": null,
          "refused_reason": null,
          "refused_reason_description": null,
          "status": "paid",
          "url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=263a8428-8602-4297-8272-531622a64cec"
        }
      ],
      "status": "paid",
      "updated_at": "2023-09-05T18:33:31.736-03:00"
    },
    {
      "amount_cents": 452645,
      "authentication_code": "2bbb59ba23478328e5bc806e9ddfe0b2",
      "bill_type": "installment",
      "billing": {
        "amount_cents": 452645,
        "amount_currency": "BRL",
        "cancelation_reason": null,
        "created_at": "2023-08-24T20:56:05.347-03:00",
        "due_day": 10,
        "finished_at": "2023-08-24T20:56:06.244-03:00",
        "id": "d7dea5cd-2e06-4d4d-8268-d75134345555",
        "installments": 1,
        "order_id": "40b61220-90bd-4290-adb6-8699d26f1a79",
        "origin_billing_id": null,
        "status": "finished",
        "updated_at": "2024-07-19T17:00:03.842-03:00"
      },
      "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=9b828137-22d3-4c30-a1d7-b502f24f1418",
      "created_at": "2023-08-24T20:56:05.355-03:00",
      "current_amount_cents": 452645,
      "disable_penalties_until": null,
      "due_date": "2023-08-27T20:56:05.350-03:00",
      "effective_due_date": "2023-08-28T20:56:05.350-03:00",
      "id": "9b828137-22d3-4c30-a1d7-b502f24f1418",
      "original_amount_cents": 452645,
      "paid_at": "2023-08-24T20:56:06.168-03:00",
      "payments": [
        {
          "amount_cents": 452645,
          "barcode": null,
          "barcode_image_url": null,
          "bill_id": "9b828137-22d3-4c30-a1d7-b502f24f1418",
          "created_at": "2023-08-24T20:56:06.092-03:00",
          "expires_at": "2023-08-27T20:56:05.350-03:00",
          "id": "9ba76cda-bb44-48b9-bc1c-9c092d7d4bcf",
          "installments": 5,
          "paid_amount_cents": 452645,
          "paid_at": "2023-08-24T20:56:06.124-03:00",
          "payment_method": "credit_card",
          "refunded_amount_cents": 0,
          "refunded_at": null,
          "refused_reason": null,
          "refused_reason_description": null,
          "status": "paid",
          "url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=9b828137-22d3-4c30-a1d7-b502f24f1418"
        }
      ],
      "status": "paid",
      "updated_at": "2023-08-24T20:56:06.181-03:00"
    }
  ],
  "total_items": 1231,
  "total_pages": 616
}