Billhighway Cloud API

<back to all web services

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 .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
}