Billhighway Cloud API

<back to all web services

UserObligation

The following routes are available for this service:
PUT/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 UserObligation
            Public Sub New()
                LineItems = New List(Of ObligationLineItem)
            End Sub

            Public Overridable Property UserId As String
            Public Overridable Property FiscalYear As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property LineItems As List(Of ObligationLineItem)
            Public Overridable Property OptedToPayCTADues As Boolean
        End Class
    End Namespace

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

        Public Partial Class ErrorDetail
            Public Overridable Property Id As Integer
            Public Overridable Property Message As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class ObligationResponse
            Implements IHaveErrorField
            Public Sub New()
                ErrorDetails = New List(Of ErrorDetail)
            End Sub

            Public Overridable Property ErrorDetails As List(Of ErrorDetail)
            Public Overridable Property IsError As Boolean
            Public Overridable Property MemberCount As Integer
            Public Overridable Property TotalAmount As Decimal
        End Class
    End Namespace
End Namespace

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