Billhighway Cloud API

<back to all web services

SalesForceInvoiceCollection

The following routes are available for this service:
POST/api/SalesForce/InvoiceCollection
SalesForceInvoiceCollection Parameters:
NameParameterData TypeRequiredDescription
InvoiceCollectionbodyList<SalesForceInvoice>No
SalesForceInvoice Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
OpportunityIdformstringNo
InvoiceDueDateformDateTimeNo
InstallmentsformintNo
FrequencyformintNo
BhUserIdformintNo
DescriptionformstringNo
DeliverformboolNo
CurrencyTypeformstringNo
InvoiceItemsformList<SalesForceInvoiceItem>No
InvoiceNoformintNo
InvoiceAmtformdecimalNo
SalesForceInvoiceItem Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
ProductNameformstringNo
AmountDueformstringNo
ProductTypeformstringNo
ActPatternTypeIdformintNo
TermStartDateformDateTimeNo
TermEndDateformDateTimeNo
RecognitionPeriodformintNo
RevenueAccountformstringNo
AccountsReceivableAccountformstringNo
LiabilityAccountformstringNo
CreditExpenseAccountformstringNo
InvoiceClearingAccountformstringNo
CostCenterformstringNo
RegionformstringNo
SalesForceInvoiceCollectionReply Parameters:
NameParameterData TypeRequiredDescription
InvoiceReplyformList<SalesForceInvoiceReply>No
IsErrorformboolNo
SalesForceInvoiceReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
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 /api/SalesForce/InvoiceCollection HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	InvoiceCollection: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			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: 
			[
				{
					ClassName: String,
					UniqueId: String,
					CreatedDateTime: 0001-01-01,
					ClientId: 0,
					ProductName: String,
					AmountDue: String,
					ProductType: String,
					ActPatternTypeId: 0,
					TermStartDate: 0001-01-01,
					TermEndDate: 0001-01-01,
					RecognitionPeriod: 0,
					RevenueAccount: String,
					AccountsReceivableAccount: String,
					LiabilityAccount: String,
					CreditExpenseAccount: String,
					InvoiceClearingAccount: String,
					CostCenter: String,
					Region: String
				}
			],
			InvoiceNo: 0,
			InvoiceAmt: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	InvoiceReply: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			ErrorCode: 0,
			ErrorMessage: String,
			InvBatchNo: 0,
			InvAmount: 0
		}
	],
	IsError: False
}