Billhighway Cloud API

UserObligationsRequest

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

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


open class UserObligationsRequest
{
    var GroupId:String? = null
    var UserId:String? = null
    var FiscalYear:Int? = null
    var ShowHistory:Boolean? = null
}

open class ObligationUser
{
    var UserId:String? = null
    var GroupId:String? = null
    var FiscalYears:ArrayList<ObligationYear> = ArrayList<ObligationYear>()
}

open class ObligationYear
{
    var FiscalYear:Int? = null
    var Obligations:ArrayList<Obligation> = ArrayList<Obligation>()
}

open class Obligation
{
    var CreatedDate:Date? = null
    var LastUpdateDate:Date? = null
    var IsActive:Boolean? = null
    var LineItems:ArrayList<ObligationLineItem> = ArrayList<ObligationLineItem>()
}

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

Kotlin UserObligationsRequest 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.

GET /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

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

<ObligationUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Response">
  <FiscalYears>
    <ObligationYear>
      <FiscalYear>0</FiscalYear>
      <Obligations>
        <Obligation>
          <CreatedDate>0001-01-01T00:00:00</CreatedDate>
          <IsActive>false</IsActive>
          <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
          <LineItems>
            <ObligationLineItem>
              <Amount>0</Amount>
              <ChartOfAccountRefId>String</ChartOfAccountRefId>
            </ObligationLineItem>
          </LineItems>
        </Obligation>
      </Obligations>
    </ObligationYear>
  </FiscalYears>
  <GroupId>String</GroupId>
  <UserId>String</UserId>
</ObligationUser>