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

GET /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

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

{
	UserId: String,
	GroupId: String,
	FiscalYears: 
	[
		{
			FiscalYear: 0,
			Obligations: 
			[
				{
					CreatedDate: 0001-01-01,
					LastUpdateDate: 0001-01-01,
					IsActive: False,
					LineItems: 
					[
						{
							ChartOfAccountRefId: String,
							Amount: 0
						}
					]
				}
			]
		}
	]
}