Billhighway Cloud API

<back to all web services

UserObligationsRequest

The following routes are available for this service:
GET/invoices/recurringInvoices/obligation
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UserObligationsRequest
    {
        public String GroupId = null;
        public String UserId = null;
        public Integer FiscalYear = null;
        public Boolean ShowHistory = null;
        
        public String getGroupId() { return GroupId; }
        public UserObligationsRequest setGroupId(String value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public UserObligationsRequest setUserId(String value) { this.UserId = value; return this; }
        public Integer getFiscalYear() { return FiscalYear; }
        public UserObligationsRequest setFiscalYear(Integer value) { this.FiscalYear = value; return this; }
        public Boolean isShowHistory() { return ShowHistory; }
        public UserObligationsRequest setShowHistory(Boolean value) { this.ShowHistory = value; return this; }
    }

    public static class ObligationUser
    {
        public String UserId = null;
        public String GroupId = null;
        public ArrayList<ObligationYear> FiscalYears = null;
        
        public String getUserId() { return UserId; }
        public ObligationUser setUserId(String value) { this.UserId = value; return this; }
        public String getGroupId() { return GroupId; }
        public ObligationUser setGroupId(String value) { this.GroupId = value; return this; }
        public ArrayList<ObligationYear> getFiscalYears() { return FiscalYears; }
        public ObligationUser setFiscalYears(ArrayList<ObligationYear> value) { this.FiscalYears = value; return this; }
    }

    public static class ObligationYear
    {
        public Integer FiscalYear = null;
        public ArrayList<Obligation> Obligations = null;
        
        public Integer getFiscalYear() { return FiscalYear; }
        public ObligationYear setFiscalYear(Integer value) { this.FiscalYear = value; return this; }
        public ArrayList<Obligation> getObligations() { return Obligations; }
        public ObligationYear setObligations(ArrayList<Obligation> value) { this.Obligations = value; return this; }
    }

    public static class Obligation
    {
        public Date CreatedDate = null;
        public Date LastUpdateDate = null;
        public Boolean IsActive = null;
        public ArrayList<ObligationLineItem> LineItems = null;
        
        public Date getCreatedDate() { return CreatedDate; }
        public Obligation setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getLastUpdateDate() { return LastUpdateDate; }
        public Obligation setLastUpdateDate(Date value) { this.LastUpdateDate = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public Obligation setIsActive(Boolean value) { this.IsActive = value; return this; }
        public ArrayList<ObligationLineItem> getLineItems() { return LineItems; }
        public Obligation setLineItems(ArrayList<ObligationLineItem> value) { this.LineItems = value; return this; }
    }

    public static class ObligationLineItem
    {
        public Integer ChartOfAccountId = null;
        public String ChartOfAccountRefId = null;
        public BigDecimal Amount = null;
        
        public Integer getChartOfAccountId() { return ChartOfAccountId; }
        public ObligationLineItem setChartOfAccountId(Integer value) { this.ChartOfAccountId = value; return this; }
        public String getChartOfAccountRefId() { return ChartOfAccountRefId; }
        public ObligationLineItem setChartOfAccountRefId(String value) { this.ChartOfAccountRefId = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public ObligationLineItem setAmount(BigDecimal value) { this.Amount = value; return this; }
    }

}

Java 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
						}
					]
				}
			]
		}
	]
}