Billhighway Cloud API

UserObligations

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

**UserObligation** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
FiscalYear	form	int	No
GroupId	form	string	No
LineItems	form	List<ObligationLineItem>	No
OptedToPayCTADues	form	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 .xml suffix or ?format=xml

HTTP + XML

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

PUT /invoices/recurringInvoices/obligations HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ArrayOfUserObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Request" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ObligationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Response">
  <ErrorDetails>
    <ErrorDetail>
      <Id>0</Id>
      <Message>String</Message>
      <Value>String</Value>
    </ErrorDetail>
  </ErrorDetails>
  <MemberCount>0</MemberCount>
  <TotalAmount>0</TotalAmount>
</ObligationResponse>