Billhighway Cloud API

UserObligationsRequest

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


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 Obligation
{
    public CreatedDate?: string;
    public LastUpdateDate?: string;
    public IsActive?: boolean;
    public LineItems?: ObligationLineItem[];

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

export class ObligationYear
{
    public FiscalYear?: number;
    public Obligations?: Obligation[];

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

export class ObligationUser
{
    public UserId?: string;
    public GroupId?: string;
    public FiscalYears?: ObligationYear[];

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

export class UserObligationsRequest
{
    public GroupId?: string;
    public UserId?: string;
    public FiscalYear?: number;
    public ShowHistory?: boolean;

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

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