Ledger Items (Facility Level)

>>>

GET /v1/:facility_id/ledgers/:ledger_id/fees
Returns a list of fee line items charged to a ledger

Examples

GET /v1/f7a96db2-6688-4a2a-bf7c-c3d3c6a3ec3e/ledgers/ba0c4a9b-8c5e-4c55-aa94-a05db9507ae9/fees
200
{
  "line_items": [
    {
      "id": "d6c13120-ae51-4e66-b6f1-81acf8127400",
      "description": "some fee",
      "quantity": 1,
      "prorated": false,
      "discount_amount": null,
      "single_item_price": 5.0,
      "subtotal": 5.0,
      "tax_total": 0,
      "total": 5.0,
      "current_product_code": "FEE-9",
      "full_description": "some fee",
      "quantifiable": false,
      "children_line_items": []
    },
    {
      "id": "1b345fde-8b7b-41b1-acb8-269964379835",
      "description": "some fee",
      "quantity": 1,
      "prorated": false,
      "discount_amount": null,
      "single_item_price": 5.0,
      "subtotal": 5.0,
      "tax_total": 0,
      "total": 5.0,
      "current_product_code": "FEE-9",
      "full_description": "some fee",
      "quantifiable": false,
      "children_line_items": []
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 2,
      "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": "f7a96db2-6688-4a2a-bf7c-c3d3c6a3ec3e",
      "ledger_id": "ba0c4a9b-8c5e-4c55-aa94-a05db9507ae9",
      "ledger_item": {}
    }
  }
}
>>>

POST /v1/:facility_id/ledgers/:ledger_id/add_fee
Add a fee to a ledger

Params

Param name Description
invoiceable_item_id
required

Validations:

  • Must be a String

Examples

POST /v1/3d59f462-cad0-4149-a6e8-0cb6d2f6c603/ledgers/61216068-fc99-4b80-a093-fc7284a970e0/add_fee
{
  "add_fee": {
    "invoiceable_item_id": "741424bf-37c8-449f-9b62-75e7549b4acf",
    "notes_attributes": [
      {
        "note": "A short note"
      }
    ]
  },
  "ledger_item": {}
}
200
{
  "line_item": {
    "id": "b4283e4a-298b-4ed9-827f-c98d03328d6d",
    "description": "some fee",
    "quantity": 1,
    "prorated": false,
    "discount_amount": null,
    "single_item_price": 5.0,
    "subtotal": 5.0,
    "tax_total": 0,
    "total": 5.0,
    "current_product_code": "FEE-8",
    "full_description": "some fee",
    "quantifiable": false,
    "children_line_items": []
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "add_fee": {
        "invoiceable_item_id": "741424bf-37c8-449f-9b62-75e7549b4acf",
        "notes_attributes": [
          {
            "note": "A short note"
          }
        ]
      },
      "facility_id": "3d59f462-cad0-4149-a6e8-0cb6d2f6c603",
      "ledger_id": "61216068-fc99-4b80-a093-fc7284a970e0",
      "ledger_item": {}
    }
  }
}
>>>

POST /v1/:facility_id/ledgers/:ledger_id/remove_fee
Removes a fee charged to a ledger

Examples

POST /v1/24fff4c6-f5bd-49d9-8e80-de5e88f9680b/ledgers/7df538e2-ad16-4cd2-8f00-4c8e8159312d/remove_fee
{
  "remove_fee": {
    "fee_line_item_id": "8628379f-db9d-48b2-9236-3a92015ea352",
    "notes_attributes": [
      {
        "note": "A short note"
      }
    ]
  },
  "ledger_item": {}
}
200
{
  "line_item": {
    "id": "ea8d874b-f155-412f-b09b-47c2102ee521",
    "description": "some fee",
    "quantity": 1,
    "prorated": false,
    "discount_amount": null,
    "single_item_price": -5.0,
    "subtotal": -5.0,
    "tax_total": 0,
    "total": -5.0,
    "current_product_code": "FEE-7",
    "full_description": "some fee - Credit",
    "quantifiable": false,
    "children_line_items": []
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "remove_fee": {
        "fee_line_item_id": "8628379f-db9d-48b2-9236-3a92015ea352",
        "notes_attributes": [
          {
            "note": "A short note"
          }
        ]
      },
      "facility_id": "24fff4c6-f5bd-49d9-8e80-de5e88f9680b",
      "ledger_id": "7df538e2-ad16-4cd2-8f00-4c8e8159312d",
      "ledger_item": {}
    }
  }
}