Billhighway Cloud API

<back to all web services

CancelInvoiceCollection

The following routes are available for this service:
POST/invoices/misc/cancelcollection
import Foundation
import ServiceStack

public class CancelInvoiceCollection : Codable
{
    public var cancelInvoices:[CancelInvoice] = []

    required public init(){}
}

public class CancelInvoice : Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var groupId:String?
    public var opportunityId:String?
    public var invoiceNumber:String?
    public var cancelledBy:String?
    public var cancelReason:String?
    public var notes:String?

    required public init(){}
}

public class CancelInvoiceCollectionReply : IHaveErrorField, Codable
{
    public var cancelInvoiceReply:[CancelInvoiceReply] = []
    public var isError:Bool?

    required public init(){}
}

public class CancelInvoiceReply : IHaveErrorField, Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var errorCode:Int?
    public var errorMessage:String?
    public var invoiceNumber:String?
    public var isError:Bool?

    required public init(){}
}


Swift CancelInvoiceCollection 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/cancelcollection HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CancelInvoices: 
	[
		{
			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

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