Billhighway Cloud API

<back to all web services

InvoiceCollection

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

public class InvoiceCollection : Codable
{
    public var invoiceList:[Invoice] = []

    required public init(){}
}

public class Invoice : IInvoiceValidation, Codable
{
    public var uniqueId:String?
    public var clientId:Int?
    public var groupId:String?
    public var Description:String?
    public var opportunityId:String?
    public var installments:Int?
    public var frequency:Int?
    public var invoiceDueDate:Date?
    public var deliver:Bool?
    public var userId:String?
    public var bhUserId:Int?
    public var currencyType:String?
    public var invoiceItems:[InvoiceItem] = []
    public var invoiceNo:Int?
    public var invoiceAmt:Double?
    public var externalInvBatchNo:String?
    public var exemptFromLateFee:Bool?

    required public init(){}
}

public class InvoiceItem : IInvoiceItemValidation, Codable
{
    public var uniqueId:String?
    public var productName:String?
    public var amountDue:Double?
    public var productType:String?
    public var actPatternTypeID:Int?
    public var termStartDate:Date?
    public var termEndDate:Date?
    public var recognitionPeriod:Int?
    public var revenueAccount:String?
    public var accountsReceivableAccount:String?
    public var liabilityAccount:String?
    public var creditExpenseAccount:String?
    public var invoiceClearingAccount:String?
    public var costCenter:String?
    public var region:String?

    required public init(){}
}

public class InvoiceCollectionReply : IHaveErrorField, Codable
{
    public var invoiceReply:[InvoiceReply] = []
    public var isError:Bool?

    required public init(){}
}

public class InvoiceReply : Codable
{
    public var uniqueId:String?
    public var errorCode:Int?
    public var errorMessage:String?
    public var invBatchNo:Int?
    public var invAmount:Double?

    required public init(){}
}

Swift InvoiceCollection DTOs

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 HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InvoiceList":[{"UniqueId":"String","ClientId":0,"GroupId":"String","UserId":"String","OpportunityId":"String","InvoiceDueDate":"0001-01-01T00:00:00.0000000","Installments":0,"Frequency":0,"BhUserId":0,"Description":"String","Deliver":false,"CurrencyType":"String","InvoiceItems":[{"ProductName":"String","AmountDue":"String","RevenueAccount":"String"}],"InvoiceNo":0,"InvoiceAmt":0,"ExternalInvBatchNo":"String","ExemptFromLateFee":false}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"InvoiceReply":[{"UniqueId":"String","ErrorCode":0,"ErrorMessage":"String","InvBatchNo":0,"InvAmount":0}],"IsError":false}