Billhighway Cloud API

<back to all web services

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UserId: String,
	GroupId: String,
	FiscalYears: 
	[
		{
			FiscalYear: 0,
			Obligations: 
			[
				{
					CreatedDate: 0001-01-01,
					LastUpdateDate: 0001-01-01,
					IsActive: False,
					LineItems: 
					[
						{
							ChartOfAccountRefId: String,
							Amount: 0
						}
					]
				}
			]
		}
	]
}