Billhighway Cloud API

<back to all web services

InvoiceCollection

The following routes are available for this service:
POST/invoices/misc
InvoiceCollection Parameters:
NameParameterData TypeRequiredDescription
InvoiceListbodyList<Invoice>No
Invoice Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ClientIdformintNo
GroupIdformstringNo
DescriptionformstringNo
OpportunityIdformstringNo
InstallmentsformintNo
FrequencyformintNo
InvoiceDueDateformDateTimeNo
DeliverformboolNo
UserIdformstringNo
BhUserIdformintNo
CurrencyTypeformstringNo
InvoiceItemsformList<InvoiceItem>No
InvoiceNoformintNo
InvoiceAmtformdecimalNo
ExternalInvBatchNoformstringNo
ExemptFromLateFeeformboolNo
InvoiceItem Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ProductNameformstringNo
AmountDueformdecimalNo
ProductTypeformstringNo
ActPatternTypeIDformintNo
TermStartDateformDateTimeNo
TermEndDateformDateTimeNo
RecognitionPeriodformintNo
RevenueAccountformstringNo
AccountsReceivableAccountformstringNo
LiabilityAccountformstringNo
CreditExpenseAccountformstringNo
InvoiceClearingAccountformstringNo
CostCenterformstringNo
RegionformstringNo
InvoiceCollectionReply Parameters:
NameParameterData TypeRequiredDescription
InvoiceReplyformList<InvoiceReply>No
IsErrorformboolNo
InvoiceReply Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ErrorCodeformintNo
ErrorMessageformstringNo
InvBatchNoformintNo
InvAmountformdecimalNo

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

{
	InvoiceList: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			OpportunityId: String,
			InvoiceDueDate: 0001-01-01,
			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: text/jsv
Content-Length: length

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