Billhighway Cloud API

<back to all web services

CreateApplyCredit

The following routes are available for this service:
POST/payments/credit
namespace BH.CloudAPI.Common4.DTO.SalesForce

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CreateApplyCreditReply() = 
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set

    [<AllowNullLiteral>]
    type SalesForceCreditInvoiceDetails() = 
        member val Invoice:Int64 = new Int64() with get,set
        member val AmountPaid:Decimal = new Decimal() with get,set
        member val Region:String = null with get,set
        member val CostCenter:String = null with get,set

    [<AllowNullLiteral>]
    type CreateApplyCredit() = 
        member val ClassName:String = null with get,set
        member val UniqueId:String = null with get,set
        member val CreatedDateTime:DateTime = new DateTime() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val UserId:String = null with get,set
        member val BhUserId:Int32 = new Int32() with get,set
        member val CreditId:Int32 = new Int32() with get,set
        member val CurrencyType:String = null with get,set
        member val CreditType:String = null with get,set
        member val Notes:String = null with get,set
        member val InvoiceDetails:ResizeArray<SalesForceCreditInvoiceDetails> = new ResizeArray<SalesForceCreditInvoiceDetails>() with get,set

F# CreateApplyCredit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<CreateApplyCredit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <BhUserId>0</BhUserId>
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <CreditId>0</CreditId>
  <CreditType>String</CreditType>
  <CurrencyType>String</CurrencyType>
  <GroupId>String</GroupId>
  <InvoiceDetails>
    <SalesForceCreditInvoiceDetails>
      <AmountPaid>0</AmountPaid>
      <CostCenter>String</CostCenter>
      <Invoice>0</Invoice>
      <Region>String</Region>
    </SalesForceCreditInvoiceDetails>
  </InvoiceDetails>
  <Notes>String</Notes>
  <UniqueId>String</UniqueId>
  <UserId>String</UserId>
</CreateApplyCredit>

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

<CreateApplyCreditReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
</CreateApplyCreditReply>