YM REST Services

<back to all web services

QBClasses

Requires Authentication
Requires any of the roles:admin, oauthadminRequires any of the permissions:/admin/donations/, /admin/store/
The following routes are available for this service:
GET/Ams/{ClientID}/QBClassesQuickBooks Classes for a client - with cache.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
GLCodesResponse Parameters:
NameParameterData TypeRequiredDescription
GLCodeListformList<GLCode>No
GLCode Parameters:
NameParameterData TypeRequiredDescription
GLCodeNameformstringNo
GLCodeIdformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/QBClasses HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GLCodeList":[{"GLCodeName":"String","GLCodeId":0}],"UsingRedis":true,"AppInitTime":"2024-05-03T08:16:34.0403300-04:00","ServerID":"WS-5-31-738","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T11:00:06.5987726-04:00","Device":"Desktop"}