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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ObligationUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Response">
  <FiscalYears>
    <ObligationYear>
      <FiscalYear>0</FiscalYear>
      <Obligations>
        <Obligation>
          <CreatedDate>0001-01-01T00:00:00</CreatedDate>
          <IsActive>false</IsActive>
          <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
          <LineItems>
            <ObligationLineItem>
              <Amount>0</Amount>
              <ChartOfAccountRefId>String</ChartOfAccountRefId>
            </ObligationLineItem>
          </LineItems>
        </Obligation>
      </Obligations>
    </ObligationYear>
  </FiscalYears>
  <GroupId>String</GroupId>
  <UserId>String</UserId>
</ObligationUser>