Params

Param name Description
id
required

Validations:

  • Must be a String

Examples

GET /v1/a262363e-6ed6-4a9b-8096-2afda4bf25d2/ledgers/276eca2a-f6cb-495b-be60-edf82bd882e2/invoices
200
{
  "invoices": [
    {
      "id": "84b6e1de-563a-4534-a109-907c8dd12617",
      "number": "#1000",
      "index": 1000,
      "prefix": "#",
      "postfix": "",
      "postfix_index": null,
      "due_on": "2023-09-13T04:38:44.498-10:00",
      "status": "finalized",
      "kind": "invoice",
      "voided": false,
      "created_by_id": 2144,
      "tenant_id": 2720,
      "facility_id": 3747,
      "parent_invoice_id": null,
      "created_at": "2023-09-15T04:38:45.423-10:00",
      "updated_at": "2023-09-15T04:38:45.522-10:00",
      "uuid": "84b6e1de-563a-4534-a109-907c8dd12617",
      "sent_to_tenant": false,
      "deleted": false,
      "deleted_on": null,
      "deleted_by_id": null,
      "total": 61.3,
      "account_balance_on_due_date": 0.0,
      "parent_invoice_number": null,
      "finalized_on": "2023-09-15",
      "children_invoices": [],
      "line_items": [
        {
          "id": "3c25e55f-650a-49d6-8cc7-959da6702aea",
          "description": "Rent Unit U103 - 10x6x4",
          "quantity": 1,
          "prorated": false,
          "discount_amount": null,
          "single_item_price": 12.0,
          "subtotal": 12.0,
          "tax_total": 1.13,
          "total": 13.13,
          "current_product_code": "Unit #U103",
          "full_description": "Rent Unit U103 - 10x6x4 (9/13/2023 - 10/12/2023)",
          "quantifiable": false,
          "children_line_items": [
            {
              "id": "b74f7ac8-67b6-4577-9c2c-7a3e9c04918d",
              "description": "Bader Program - $46,000.00",
              "quantity": 1,
              "prorated": false,
              "discount_amount": null,
              "single_item_price": 43.09,
              "subtotal": 43.09,
              "tax_total": 0,
              "total": 43.09,
              "current_product_code": "BADER-1",
              "full_description": "Bader Program - $46,000.00 (9/13/2023 - 10/12/2023)",
              "quantifiable": false,
              "children_line_items": []
            },
            {
              "id": "65979c1e-d29c-4079-b7ef-7c9e04195ac2",
              "description": "Some service item",
              "quantity": 1,
              "prorated": false,
              "discount_amount": null,
              "single_item_price": 5.08,
              "subtotal": 5.08,
              "tax_total": 0,
              "total": 5.08,
              "current_product_code": "S-13",
              "full_description": "Some service item (9/13/2023 - 10/12/2023)",
              "quantifiable": false,
              "children_line_items": []
            }
          ]
        },
        {
          "id": "b74f7ac8-67b6-4577-9c2c-7a3e9c04918d",
          "description": "Bader Program - $46,000.00",
          "quantity": 1,
          "prorated": false,
          "discount_amount": null,
          "single_item_price": 43.09,
          "subtotal": 43.09,
          "tax_total": 0,
          "total": 43.09,
          "current_product_code": "BADER-1",
          "full_description": "Bader Program - $46,000.00 (9/13/2023 - 10/12/2023)",
          "quantifiable": false,
          "children_line_items": []
        },
        {
          "id": "65979c1e-d29c-4079-b7ef-7c9e04195ac2",
          "description": "Some service item",
          "quantity": 1,
          "prorated": false,
          "discount_amount": null,
          "single_item_price": 5.08,
          "subtotal": 5.08,
          "tax_total": 0,
          "total": 5.08,
          "current_product_code": "S-13",
          "full_description": "Some service item (9/13/2023 - 10/12/2023)",
          "quantifiable": false,
          "children_line_items": []
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 1,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "a262363e-6ed6-4a9b-8096-2afda4bf25d2",
      "ledger_id": "276eca2a-f6cb-495b-be60-edf82bd882e2",
      "ledger": {}
    }
  }
}