Billhighway Cloud API

<back to all web services

CreateApplyCredit

The following routes are available for this service:
POST/payments/credit

export class CreateApplyCreditReply
{
    public ErrorCode?: number;
    public ErrorMessage?: string;

    public constructor(init?: Partial<CreateApplyCreditReply>) { (Object as any).assign(this, init); }
}

export class SalesForceCreditInvoiceDetails
{
    public Invoice?: number;
    public AmountPaid?: number;
    public Region?: string;
    public CostCenter?: string;

    public constructor(init?: Partial<SalesForceCreditInvoiceDetails>) { (Object as any).assign(this, init); }
}

export class CreateApplyCredit
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public CreditId?: number;
    public CurrencyType?: string;
    public CreditType?: string;
    public Notes?: string;
    public InvoiceDetails?: SalesForceCreditInvoiceDetails[];

    public constructor(init?: Partial<CreateApplyCredit>) { (Object as any).assign(this, init); }
}

TypeScript 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>