Billhighway Cloud API

<back to all web services

UserObligation

The following routes are available for this service:
PUT/invoices/recurringInvoices/obligation
UserObligation Parameters:
NameParameterData TypeRequiredDescription
UserIdbodystringNo
FiscalYearbodyintNo
GroupIdbodystringNo
LineItemsbodyList<ObligationLineItem>No
OptedToPayCTADuesbodyboolNo
ObligationLineItem Parameters:
NameParameterData TypeRequiredDescription
ChartOfAccountIdformintNo
ChartOfAccountRefIdformstringNo
Amountformdecimal?No
ObligationResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorDetailsformList<ErrorDetail>No
IsErrorformboolNo
MemberCountformintNo
TotalAmountformdecimalNo
ErrorDetail Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
MessageformstringNo
ValueformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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