Billhighway Cloud API

<back to all web services

CancelInvoiceCollection

The following routes are available for this service:
POST/invoices/misc/cancelcollection
CancelInvoiceCollection Parameters:
NameParameterData TypeRequiredDescription
CancelInvoicesbodyList<CancelInvoice>No
CancelInvoice Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
OpportunityIdformstringNo
InvoiceNumberformstringNo
CancelledByformstringNo
CancelReasonformstringNo
NotesformstringNo
CancelInvoiceCollectionReply Parameters:
NameParameterData TypeRequiredDescription
CancelInvoiceReplyformList<CancelInvoiceReply>No
IsErrorformboolNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /invoices/misc/cancelcollection HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CancelInvoices":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","OpportunityId":"String","InvoiceNumber":"String","CancelledBy":"String","CancelReason":"String","Notes":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CancelInvoiceReply":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"ErrorCode":0,"ErrorMessage":"String","InvoiceNumber":"String","IsError":false}],"IsError":false}