Billhighway Cloud API

UserObligationsRequest

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

namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ObligationLineItem() = 
        member val ChartOfAccountId:Int32 = new Int32() with get,set
        member val ChartOfAccountRefId:String = null with get,set
        member val Amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type Obligation() = 
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val LastUpdateDate:DateTime = new DateTime() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val LineItems:ResizeArray<ObligationLineItem> = new ResizeArray<ObligationLineItem>() with get,set

    [<AllowNullLiteral>]
    type ObligationYear() = 
        member val FiscalYear:Int32 = new Int32() with get,set
        member val Obligations:ResizeArray<Obligation> = new ResizeArray<Obligation>() with get,set

    [<AllowNullLiteral>]
    type ObligationUser() = 
        member val UserId:String = null with get,set
        member val GroupId:String = null with get,set
        member val FiscalYears:ResizeArray<ObligationYear> = new ResizeArray<ObligationYear>() with get,set

    [<AllowNullLiteral>]
    type UserObligationsRequest() = 
        member val GroupId:String = null with get,set
        member val UserId:String = null with get,set
        member val FiscalYear:Int32 = new Int32() with get,set
        member val ShowHistory:Boolean = new Boolean() with get,set

F# 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>