Billhighway Cloud API

UserObligationsRequest

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

import Foundation
import ServiceStack

public class UserObligationsRequest : Codable
{
    public var groupId:String?
    public var userId:String?
    public var fiscalYear:Int?
    public var showHistory:Bool?

    required public init(){}
}

public class ObligationUser : Codable
{
    public var userId:String?
    public var groupId:String?
    public var fiscalYears:[ObligationYear] = []

    required public init(){}
}

public class ObligationYear : Codable
{
    public var fiscalYear:Int?
    public var obligations:[Obligation] = []

    required public init(){}
}

public class Obligation : Codable
{
    public var createdDate:Date?
    public var lastUpdateDate:Date?
    public var isActive:Bool?
    public var lineItems:[ObligationLineItem] = []

    required public init(){}
}

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

    required public init(){}
}

Swift 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
						}
					]
				}
			]
		}
	]
}