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

PUT /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Request">
  <FiscalYear>0</FiscalYear>
  <GroupId>String</GroupId>
  <LineItems>
    <ObligationLineItem>
      <Amount>0</Amount>
      <ChartOfAccountId>0</ChartOfAccountId>
      <ChartOfAccountRefId>String</ChartOfAccountRefId>
    </ObligationLineItem>
  </LineItems>
  <OptedToPayCTADues>false</OptedToPayCTADues>
  <UserId>String</UserId>
</UserObligation>

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

<ObligationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringInvoice.Response">
  <ErrorDetails>
    <ErrorDetail>
      <Id>0</Id>
      <Message>String</Message>
      <Value>String</Value>
    </ErrorDetail>
  </ErrorDetails>
  <MemberCount>0</MemberCount>
  <TotalAmount>0</TotalAmount>
</ObligationResponse>