Billhighway Cloud API

UserObligation

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

**UserObligation** Parameters:
Name	Parameter	Data Type	Required
UserId	body	string	No
FiscalYear	body	int	No
GroupId	body	string	No
LineItems	body	List<ObligationLineItem>	No
OptedToPayCTADues	body	bool	No

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

**ObligationResponse** Parameters:
Name	Parameter	Data Type	Required
ErrorDetails	form	List<ErrorDetail>	No
IsError	form	bool	No
MemberCount	form	int	No
TotalAmount	form	decimal	No

**ErrorDetail** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Message	form	string	No
Value	form	string	No

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

HTTP + JSV

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

PUT /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserId: String,
	FiscalYear: 0,
	GroupId: String,
	LineItems: 
	[
		{
			ChartOfAccountId: 0,
			ChartOfAccountRefId: String,
			Amount: 0
		}
	],
	OptedToPayCTADues: False
}

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

{
	ErrorDetails: 
	[
		{
			Id: 0,
			Message: String,
			Value: String
		}
	],
	IsError: True,
	MemberCount: 0,
	TotalAmount: 0
}