Billhighway Cloud API

<back to all web services

CreateApplyCredit

The following routes are available for this service:
POST/payments/credit
CreateApplyCredit Parameters:
NameParameterData TypeRequiredDescription
ClassNamebodystringNo
UniqueIdbodystringNo
CreatedDateTimebodyDateTimeNo
ClientIdbodyintNo
GroupIdbodystringNo
UserIdbodystringNo
BhUserIdbodyintNo
CreditIdbodyintNo
CurrencyTypebodystringNo
CreditTypebodystringNo
NotesbodystringNo
InvoiceDetailsbodyList<SalesForceCreditInvoiceDetails>No
SalesForceCreditInvoiceDetails Parameters:
NameParameterData TypeRequiredDescription
InvoiceformlongNo
AmountPaidformdecimalNo
RegionformstringNo
CostCenterformstringNo
CreateApplyCreditReply Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformintNo
ErrorMessageformstringNo

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

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"CreditId":0,"CurrencyType":"String","CreditType":"String","Notes":"String","InvoiceDetails":[{"Invoice":0,"AmountPaid":0,"Region":"String","CostCenter":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":0,"ErrorMessage":"String"}