Billhighway Cloud API

UserObligationsRequest

The following routes are available for this service:
GET	/invoices/recurringInvoices/obligation

**UserObligationsRequest** Parameters:
Name	Parameter	Data Type	Required
GroupId	query	string	No
UserId	query	string	No
FiscalYear	query	int	No
ShowHistory	query	bool	No

**ObligationUser** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
GroupId	form	string	No
FiscalYears	form	List<ObligationYear>	No

**ObligationYear** Parameters:
Name	Parameter	Data Type	Required	Description
FiscalYear	form	int	No
Obligations	form	List<Obligation>	No

**Obligation** Parameters:
Name	Parameter	Data Type	Required
CreatedDate	form	DateTime	No
LastUpdateDate	form	DateTime	No
IsActive	form	bool	No
LineItems	form	List<ObligationLineItem>	No

**ObligationLineItem** Parameters:
Name	Parameter	Data Type	Required
ChartOfAccountId	form	int	No
ChartOfAccountRefId	form	string	No
Amount	form	decimal?	No

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 /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserId":"String","GroupId":"String","FiscalYears":[{"FiscalYear":0,"Obligations":[{"CreatedDate":"0001-01-01T00:00:00.0000000","LastUpdateDate":"0001-01-01T00:00:00.0000000","IsActive":false,"LineItems":[{"ChartOfAccountRefId":"String","Amount":0}]}]}]}