Billhighway Cloud API

CreateApplyCredit

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateApplyCreditReply:
    error_code: Optional[int] = None
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceCreditInvoiceDetails:
    invoice: Optional[int] = None
    amount_paid: Optional[Decimal] = None
    region: Optional[str] = None
    cost_center: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateApplyCredit:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    credit_id: Optional[int] = None
    currency_type: Optional[str] = None
    credit_type: Optional[str] = None
    notes: Optional[str] = None
    invoice_details: Optional[List[SalesForceCreditInvoiceDetails]] = None

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