Billhighway Cloud API

<back to all web services

SalesForceCancelInvoiceCollection

The following routes are available for this service:
POST/api/SalesForce/CancelInvoiceCollection
SalesForceCancelInvoiceCollection Parameters:
NameParameterData TypeRequiredDescription
CancelInvoiceCollectionbodyList<SalesForceCancelInvoice>No
SalesForceCancelInvoice Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
OpportunityIdformstringNo
InvoiceNumberformstringNo
CancelledByformstringNo
CancelReasonformstringNo
NotesformstringNo
SalesForceCancelInvoiceCollectionReply Parameters:
NameParameterData TypeRequiredDescription
CancelInvoiceReplyformList<SalesForceCancelInvoiceReply>No
IsErrorformboolNo
SalesForceCancelInvoiceReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
ErrorCodeformintNo
ErrorMessageformstringNo
InvoiceNumberformstringNo
IsErrorformboolNo

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 /api/SalesForce/CancelInvoiceCollection HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CancelInvoiceCollection: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			GroupId: String,
			OpportunityId: String,
			InvoiceNumber: String,
			CancelledBy: String,
			CancelReason: String,
			Notes: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CancelInvoiceReply: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			ErrorCode: 0,
			ErrorMessage: String,
			InvoiceNumber: String,
			IsError: False
		}
	],
	IsError: False
}