Billhighway Cloud API

<back to all web services

RecurringInvoiceListRequest

The following routes are available for this service:
GET/invoices/recurringInvoices
namespace BH.CloudAPI.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RecurringInvoiceListResponseItem() = 
        member val GroupID:String = null with get,set
        member val RecurringInvoiceID:Int32 = new Int32() with get,set
        member val BillingTypeID:Int32 = new Int32() with get,set
        member val BillingTypeName:String = null with get,set
        member val InvoiceDescription:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ProcessingCurrency:String = null with get,set
        member val FrequencyDescription:String = null with get,set
        member val EffectiveDate:DateTime = new DateTime() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val NextDueDate:DateTime = new DateTime() with get,set
        member val DonationCoaNum:String = null with get,set
        member val DonationCoaDesc:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val FrequencySummary:String = null with get,set

    [<AllowNullLiteral>]
    type RecurringInvoiceListResponse() = 
        member val Results:ResizeArray<RecurringInvoiceListResponseItem> = new ResizeArray<RecurringInvoiceListResponseItem>() with get,set

    [<AllowNullLiteral>]
    type RecurringInvoiceListRequest() = 
        member val GroupID:String = null with get,set

F# 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"}]}