Billhighway Cloud API

UserObligations

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

import Foundation
import ServiceStack

public class UserObligations : List<UserObligation>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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 UserObligations DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /invoices/recurringInvoices/obligations HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

[]

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

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