Billhighway Cloud API

UserObligation

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class UserObligation
{
    var UserId:String? = null
    var FiscalYear:Int? = null
    var GroupId:String? = null
    var LineItems:ArrayList<ObligationLineItem> = ArrayList<ObligationLineItem>()
    var OptedToPayCTADues:Boolean? = null
}

open class ObligationLineItem
{
    var ChartOfAccountId:Int? = null
    var ChartOfAccountRefId:String? = null
    var Amount:BigDecimal? = null
}

open class ObligationResponse : IHaveErrorField
{
    var ErrorDetails:ArrayList<ErrorDetail> = ArrayList<ErrorDetail>()
    var IsError:Boolean? = null
    var MemberCount:Int? = null
    var TotalAmount:BigDecimal? = null
}

open class ErrorDetail
{
    var Id:Int? = null
    var Message:String? = null
    var Value:String? = null
}

Kotlin UserObligation DTOs

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/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Request">
  <FiscalYear>0</FiscalYear>
  <GroupId>String</GroupId>
  <LineItems>
    <ObligationLineItem>
      <Amount>0</Amount>
      <ChartOfAccountId>0</ChartOfAccountId>
      <ChartOfAccountRefId>String</ChartOfAccountRefId>
    </ObligationLineItem>
  </LineItems>
  <OptedToPayCTADues>false</OptedToPayCTADues>
  <UserId>String</UserId>
</UserObligation>

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>