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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class ReceiptResponse
    {
        public virtual ReceiptSentStatus Email { get; set; }
        public virtual ReceiptSentStatus Sms { get; set; }
    }

    public partial class ReceiptSentStatus
    {
        public virtual bool IsSent { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class Receipt
        : Receipt, IReturnLegacyException
    {
    }

}

C# Receipt DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	Email: 
	{
		IsSent: False
	},
	Sms: 
	{
		IsSent: False
	}
}