API Docs

__METHOD= GET . __PATH= /almaws/v1/users/{user_id}/fees .

Get user fines/fees

This API returns a user's fines and fees.

Resource URL

GET /almaws/v1/users/{user_id}/fees

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

Querystring Parameters

ParameterTypeRequiredDescription
user_id_typexs:stringOptional. Default: all_uniqueThe 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.
statusxs:stringOptional. Default: ACTIVEReturn 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

CodeMessage
402119General error.
401651Identifier not found.
401666Parameter is not valid.