API Docs
Get user fines/fees
Contents
This API returns a user's fines and fees.
Resource URL
GET /almaws/v1/users/{user_id}/fees
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. |
status | xs:string | Optional. Default: ACTIVE | Return fees of this status only. Optional. If this is not provided, all active fees will be returned. The values that can be used are {ACTIVE|INDISPUTE|EXPORTED|CLOSED}. |
Body Parameters
None
Output
This method returns a Fees
object. See doc
Possible Error Codes
Code | Message |
---|---|
402119 | General error. |
401651 | Identifier not found. |
401666 | Parameter is not valid. |
60258 | The API Restricted profile is not valid. |