Billhighway Cloud API

UserObligation

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

import Foundation
import ServiceStack

public class UserObligation : Codable
{
    public var userId:String?
    public var fiscalYear:Int?
    public var groupId:String?
    public var lineItems:[ObligationLineItem] = []
    public var optedToPayCTADues:Bool?

    required public init(){}
}

public class ObligationLineItem : Codable
{
    public var chartOfAccountId:Int?
    public var chartOfAccountRefId:String?
    public var amount:Double?

    required public init(){}
}

public class ObligationResponse : IHaveErrorField, Codable
{
    public var errorDetails:[ErrorDetail] = []
    public var isError:Bool?
    public var memberCount:Int?
    public var totalAmount:Double?

    required public init(){}
}

public class ErrorDetail : Codable
{
    public var id:Int?
    public var message:String?
    public var value:String?

    required public init(){}
}

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

PUT /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

{
	ErrorDetails: 
	[
		{
			Id: 0,
			Message: String,
			Value: String
		}
	],
	IsError: True,
	MemberCount: 0,
	TotalAmount: 0
}