Billhighway Cloud API

CancelInvoice

The following routes are available for this service:
POST	/invoices/misc/cancel


export class CancelInvoiceReply implements IHaveErrorField
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    public InvoiceNumber?: string;
    public IsError?: boolean;

    public constructor(init?: Partial<CancelInvoiceReply>) { (Object as any).assign(this, init); }
}

export class CancelInvoice
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public OpportunityId?: string;
    public InvoiceNumber?: string;
    public CancelledBy?: string;
    public CancelReason?: string;
    public Notes?: string;

    public constructor(init?: Partial<CancelInvoice>) { (Object as any).assign(this, init); }
}

TypeScript CancelInvoice DTOs

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>