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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CancelInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CancelReason>String</CancelReason>
  <CancelledBy>String</CancelledBy>
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <GroupId>String</GroupId>
  <InvoiceNumber>String</InvoiceNumber>
  <Notes>String</Notes>
  <OpportunityId>String</OpportunityId>
  <UniqueId>String</UniqueId>
</CancelInvoice>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CancelInvoiceReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <InvoiceNumber>String</InvoiceNumber>
  <UniqueId>String</UniqueId>
</CancelInvoiceReply>