Billhighway Cloud API

UserObligation

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


export class ErrorDetail
{
    public Id?: number;
    public Message?: string;
    public Value?: string;

    public constructor(init?: Partial<ErrorDetail>) { (Object as any).assign(this, init); }
}

export class ObligationResponse implements IHaveErrorField
{
    public ErrorDetails?: ErrorDetail[];
    public IsError?: boolean;
    public MemberCount?: number;
    public TotalAmount?: number;

    public constructor(init?: Partial<ObligationResponse>) { (Object as any).assign(this, init); }
}

export class ObligationLineItem
{
    public ChartOfAccountId?: number;
    public ChartOfAccountRefId?: string;
    public Amount?: number;

    public constructor(init?: Partial<ObligationLineItem>) { (Object as any).assign(this, init); }
}

export class UserObligation
{
    public UserId?: string;
    public FiscalYear?: number;
    public GroupId?: string;
    public LineItems?: ObligationLineItem[];
    public OptedToPayCTADues?: boolean;

    public constructor(init?: Partial<UserObligation>) { (Object as any).assign(this, init); }
}

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

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

{
	ErrorDetails: 
	[
		{
			Id: 0,
			Message: String,
			Value: String
		}
	],
	IsError: True,
	MemberCount: 0,
	TotalAmount: 0
}