Ledger items

>>>

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

Examples

GET /v1/84f3beef-433a-405d-9a0e-09b5cd7ddd90/ledgers/35809a9c-7583-4404-99fd-563901946c88/fees
200
{
  "line_items": [
    {
      "id": "bb0ee255-dd16-4e16-837f-bd351cb0f6b1",
      "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",
      "quantifiable": false,
      "children_line_items": []
    },
    {
      "id": "b49da555-2341-4543-96ec-16f93f7e3f5b",
      "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",
      "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": "84f3beef-433a-405d-9a0e-09b5cd7ddd90",
      "ledger_id": "35809a9c-7583-4404-99fd-563901946c88"
    }
  }
}
>>>

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

Examples

POST /v1/ec12c0e6-f2d4-49e3-a5c3-483e25557db1/ledgers/94b687db-11eb-4337-aa64-19089a3de4e7/add_fee
{
  "add_fee": {
    "invoiceable_item_id": "29cdbe1d-18f8-49e0-be4d-1f6ec8b0319f",
    "notes_attributes": [
      {
        "note": "A short note"
      }
    ]
  }
}
200
{
  "line_item": {
    "id": "09c7fed2-f9e2-4634-a153-a6aaa71d48b7",
    "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": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "add_fee": {
        "invoiceable_item_id": "29cdbe1d-18f8-49e0-be4d-1f6ec8b0319f",
        "notes_attributes": [
          {
            "note": "A short note"
          }
        ]
      },
      "facility_id": "ec12c0e6-f2d4-49e3-a5c3-483e25557db1",
      "ledger_id": "94b687db-11eb-4337-aa64-19089a3de4e7"
    }
  }
}

Params

Param name Description
invoiceable_item_id
required
Value: Must be a String
>>>

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

Examples

POST /v1/17f63a8a-3da1-4934-b187-d76ae311ff75/ledgers/fc7147ca-fbdc-4d27-929f-0906fbcc43c4/remove_fee
{
  "remove_fee": {
    "fee_line_item_id": "6c0ea3f0-9ca2-4cf0-b063-d3fbd60cbe91",
    "notes_attributes": [
      {
        "note": "A short note"
      }
    ]
  }
}
200
{
  "line_item": {
    "id": "d6b617f4-5454-401c-ac5c-49472acf45d3",
    "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 - 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": "6c0ea3f0-9ca2-4cf0-b063-d3fbd60cbe91",
        "notes_attributes": [
          {
            "note": "A short note"
          }
        ]
      },
      "facility_id": "17f63a8a-3da1-4934-b187-d76ae311ff75",
      "ledger_id": "fc7147ca-fbdc-4d27-929f-0906fbcc43c4"
    }
  }
}