Billhighway Cloud API

<back to all web services

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