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

PUT /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Request">
  <FiscalYear>0</FiscalYear>
  <GroupId>String</GroupId>
  <LineItems>
    <ObligationLineItem>
      <Amount>0</Amount>
      <ChartOfAccountId>0</ChartOfAccountId>
      <ChartOfAccountRefId>String</ChartOfAccountRefId>
    </ObligationLineItem>
  </LineItems>
  <OptedToPayCTADues>false</OptedToPayCTADues>
  <UserId>String</UserId>
</UserObligation>

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

<ObligationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Response">
  <ErrorDetails>
    <ErrorDetail>
      <Id>0</Id>
      <Message>String</Message>
      <Value>String</Value>
    </ErrorDetail>
  </ErrorDetails>
  <MemberCount>0</MemberCount>
  <TotalAmount>0</TotalAmount>
</ObligationResponse>