Billhighway Cloud API

UserObligationsRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.RecurringInvoice.Request;
using BH.CloudAPI.Common4.DTO.RecurringInvoice.Response;

namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Request
{
    public partial class ObligationLineItem
    {
        public virtual int ChartOfAccountId { get; set; }
        public virtual string ChartOfAccountRefId { get; set; }
        public virtual decimal? Amount { get; set; }
    }

    public partial class UserObligationsRequest
    {
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual int FiscalYear { get; set; }
        public virtual bool ShowHistory { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Response
{
    public partial class Obligation
    {
        public Obligation()
        {
            LineItems = new List<ObligationLineItem>{};
        }

        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime LastUpdateDate { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual List<ObligationLineItem> LineItems { get; set; }
    }

    public partial class ObligationUser
    {
        public ObligationUser()
        {
            FiscalYears = new List<ObligationYear>{};
        }

        public virtual string UserId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual List<ObligationYear> FiscalYears { get; set; }
    }

    public partial class ObligationYear
    {
        public ObligationYear()
        {
            Obligations = new List<Obligation>{};
        }

        public virtual int FiscalYear { get; set; }
        public virtual List<Obligation> Obligations { get; set; }
    }

}

C# UserObligationsRequest 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.

GET /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ObligationUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Response">
  <FiscalYears>
    <ObligationYear>
      <FiscalYear>0</FiscalYear>
      <Obligations>
        <Obligation>
          <CreatedDate>0001-01-01T00:00:00</CreatedDate>
          <IsActive>false</IsActive>
          <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
          <LineItems>
            <ObligationLineItem>
              <Amount>0</Amount>
              <ChartOfAccountRefId>String</ChartOfAccountRefId>
            </ObligationLineItem>
          </LineItems>
        </Obligation>
      </Obligations>
    </ObligationYear>
  </FiscalYears>
  <GroupId>String</GroupId>
  <UserId>String</UserId>
</ObligationUser>