Billhighway Cloud API

<back to all web services

CancelInvoice

The following routes are available for this service:
POST/invoices/misc/cancel
CancelInvoice Parameters:
NameParameterData TypeRequiredDescription
ClassNamebodystringNo
UniqueIdbodystringNo
CreatedDateTimebodyDateTimeNo
ClientIdbodyintNo
GroupIdbodystringNo
OpportunityIdbodystringNo
InvoiceNumberbodystringNo
CancelledBybodystringNo
CancelReasonbodystringNo
NotesbodystringNo
CancelInvoiceReply 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 /invoices/misc/cancel HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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

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