Fee Reason Codes

Get Fee reason codes

GET /api/.../feereasons/{id}

Return an individual FeeReasonCode.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique Id assigned to feereasoncode.

Response Information

Example
application/json, text/json 
{
    "FeeReasonCodeID":-11,
    "FeeDescription":"Check Out Charge",
    "TaxRateID":9,
    "DefaultAmount":2.22
}

List Fee reason codes

GET /api/.../feereasoncodes

Return a list of all fee reason codes in the system.

GET /api/.../feereasoncodes?orgid={orgid}

Return a list of all fee reason codes for an individual organization.

GET /api/.../feereasoncodes?orgid={orgid}&includeEmptyObject=true

Return a list of all fee reason codes for an individual organization. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
orgid Integer No Filter by organization Id.
includeEmptyObject Boolean No Set to 'true' to return an empty object with FeeReasonCodeID set to '-100' and Description set to '(none)'. This may be used when populating a listbox for a user selection. Must be used with the orgid parameter.

Response Information

Example
application/json, text/json 
[
    {
        "FeeReasonCodeID":-6,
        "FeeDescription":"Processing Charge",
        "TaxRateID":8,
        "DefaultAmount":2.22
    },
    {
        "FeeReasonCodeID":-3,
        "FeeDescription":"Hold Request",
        "TaxRateID":8,
        "DefaultAmount":2.22
    },
    {
        "FeeReasonCodeID":2,
        "FeeDescription":"Copy / Print",
        "TaxRateID":8,
        "DefaultAmount":2.22
    },
    {
        "FeeReasonCodeID":-1,
        "FeeDescription":"Replacement Cost",
        "TaxRateID":null,
        "DefaultAmount":2.22
    },
    {
        "FeeReasonCodeID":3,
        "FeeDescription":"Damage",
        "TaxRateID":2,
        "DefaultAmount":2.22
    },
        {
        "FeeReasonCodeID":4,
        "FeeDescription":"ILL",
        "TaxRateID":8,
        "DefaultAmount":1.5
    },
    {
        "FeeReasonCodeID":5,
        "FeeDescription":"Manual Fine",
        "TaxRateID":8,
        "DefaultAmount":2.22
    },
    {
        "FeeReasonCodeID":6,
        "FeeDescription":"New Card",
        "TaxRateID":6,
        "DefaultAmount":1
    },
    {
        "FeeReasonCodeID":8,
        "FeeDescription":"Postage",
        "TaxRateID":null,
        "DefaultAmount":0
    }
 ]

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request