Billhighway Cloud API

<back to all web services

UserObligation

The following routes are available for this service:
PUT/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 ErrorDetail() = 
        member val Id:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type ObligationResponse() = 
        member val ErrorDetails:ResizeArray<ErrorDetail> = new ResizeArray<ErrorDetail>() with get,set
        member val IsError:Boolean = new Boolean() with get,set
        member val MemberCount:Int32 = new Int32() with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set

    [<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 UserObligation() = 
        member val UserId:String = null with get,set
        member val FiscalYear:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val LineItems:ResizeArray<ObligationLineItem> = new ResizeArray<ObligationLineItem>() with get,set
        member val OptedToPayCTADues:Boolean = new Boolean() with get,set

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