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 .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/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserId":"String","FiscalYear":0,"GroupId":"String","LineItems":[{"ChartOfAccountId":0,"ChartOfAccountRefId":"String","Amount":0}],"OptedToPayCTADues":false}
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}