| GET | /invoices/recurringInvoices |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupID | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<RecurringInvoiceListResponseItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupID | form | string | No | |
| RecurringInvoiceID | form | int | No | |
| BillingTypeID | form | int | No | |
| BillingTypeName | form | string | No | |
| InvoiceDescription | form | string | No | |
| Amount | form | decimal | No | |
| ProcessingCurrency | form | string | No | |
| FrequencyDescription | form | string | No | |
| EffectiveDate | form | DateTime | No | |
| EndDate | form | DateTime? | No | |
| NextDueDate | form | DateTime | No | |
| DonationCoaNum | form | string | No | |
| DonationCoaDesc | form | string | No | |
| IsActive | form | bool | No | |
| FrequencySummary | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Results:
[
{
GroupID: String,
RecurringInvoiceID: 0,
BillingTypeID: 0,
BillingTypeName: String,
InvoiceDescription: String,
Amount: 0,
ProcessingCurrency: String,
FrequencyDescription: String,
EffectiveDate: 0001-01-01,
EndDate: 0001-01-01,
NextDueDate: 0001-01-01,
DonationCoaNum: String,
DonationCoaDesc: String,
IsActive: False,
FrequencySummary: String
}
]
}