Billhighway Cloud API

UserObligationsRequest

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

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

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Request

        Public Partial Class ObligationLineItem
            Public Overridable Property ChartOfAccountId As Integer
            Public Overridable Property ChartOfAccountRefId As String
            Public Overridable Property Amount As Nullable(Of Decimal)
        End Class

        Public Partial Class UserObligationsRequest
            Public Overridable Property GroupId As String
            Public Overridable Property UserId As String
            Public Overridable Property FiscalYear As Integer
            Public Overridable Property ShowHistory As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Response

        Public Partial Class Obligation
            Public Sub New()
                LineItems = New List(Of ObligationLineItem)
            End Sub

            Public Overridable Property CreatedDate As Date
            Public Overridable Property LastUpdateDate As Date
            Public Overridable Property IsActive As Boolean
            Public Overridable Property LineItems As List(Of ObligationLineItem)
        End Class

        Public Partial Class ObligationUser
            Public Sub New()
                FiscalYears = New List(Of ObligationYear)
            End Sub

            Public Overridable Property UserId As String
            Public Overridable Property GroupId As String
            Public Overridable Property FiscalYears As List(Of ObligationYear)
        End Class

        Public Partial Class ObligationYear
            Public Sub New()
                Obligations = New List(Of Obligation)
            End Sub

            Public Overridable Property FiscalYear As Integer
            Public Overridable Property Obligations As List(Of Obligation)
        End Class
    End Namespace
End Namespace

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