Billhighway Cloud API

UserObligation

The following routes are available for this service:
PUT	/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 UserObligation
    {
        public UserObligation()
        {
            LineItems = new List<ObligationLineItem>{};
        }

        public virtual string UserId { get; set; }
        public virtual int FiscalYear { get; set; }
        public virtual string GroupId { get; set; }
        public virtual List<ObligationLineItem> LineItems { get; set; }
        public virtual bool OptedToPayCTADues { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Response
{
    public partial class ErrorDetail
    {
        public virtual int Id { get; set; }
        public virtual string Message { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class ObligationResponse
        : IHaveErrorField
    {
        public ObligationResponse()
        {
            ErrorDetails = new List<ErrorDetail>{};
        }

        public virtual List<ErrorDetail> ErrorDetails { get; set; }
        public virtual bool IsError { get; set; }
        public virtual int MemberCount { get; set; }
        public virtual decimal TotalAmount { get; set; }
    }

}

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