Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

The following routes are available for this service:
GET/invoices/recurringInvoices
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.DTO

Namespace Global

    Namespace BH.CloudAPI.DTO

        Public Partial Class RecurringInvoiceListRequest
            Public Overridable Property GroupID As String
        End Class

        Public Partial Class RecurringInvoiceListResponse
            Public Sub New()
                Results = New List(Of RecurringInvoiceListResponseItem)
            End Sub

            Public Overridable Property Results As List(Of RecurringInvoiceListResponseItem)
        End Class

        Public Partial Class RecurringInvoiceListResponseItem
            Public Overridable Property GroupID As String
            Public Overridable Property RecurringInvoiceID As Integer
            Public Overridable Property BillingTypeID As Integer
            Public Overridable Property BillingTypeName As String
            Public Overridable Property InvoiceDescription As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property ProcessingCurrency As String
            Public Overridable Property FrequencyDescription As String
            Public Overridable Property EffectiveDate As Date
            Public Overridable Property EndDate As Nullable(Of Date)
            Public Overridable Property NextDueDate As Date
            Public Overridable Property DonationCoaNum As String
            Public Overridable Property DonationCoaDesc As String
            Public Overridable Property IsActive As Boolean
            Public Overridable Property FrequencySummary As String
        End Class
    End Namespace
End Namespace

VB.NET RecurringInvoiceListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /invoices/recurringInvoices HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"GroupID":"String","RecurringInvoiceID":0,"BillingTypeID":0,"BillingTypeName":"String","InvoiceDescription":"String","Amount":0,"ProcessingCurrency":"String","FrequencyDescription":"String","EffectiveDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","NextDueDate":"0001-01-01T00:00:00.0000000","DonationCoaNum":"String","DonationCoaDesc":"String","IsActive":false,"FrequencySummary":"String"}]}