Billhighway Cloud API

<back to all web services

Receipt

The following routes are available for this service:
POST/v1.1/receipts/send
POST/v1.2/receipts/send
namespace BH.CloudAPI.Common.DTO

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

    [<AllowNullLiteral>]
    type ReceiptSentStatus() = 
        member val IsSent:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ReceiptResponse() = 
        member val Email:ReceiptSentStatus = null with get,set
        member val Sms:ReceiptSentStatus = null with get,set

    [<AllowNullLiteral>]
    type Receipt() = 
        inherit Receipt()

F# Receipt 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.

POST /v1.1/receipts/send HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"EmailReceiptRequest":{"From":"String","Subject":"String","Message":"String","To":"String"},"SmsReceiptRequest":{"Message":"String","To":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Email":{"IsSent":false},"Sms":{"IsSent":false}}