Billhighway Cloud API

<back to all web services

MemberStatusValues

The following routes are available for this service:
GET/members/StatusValues
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 AutoPayInfo:
    payment_method: Optional[str] = None
    card_type: Optional[str] = None
    card_reference: Optional[str] = None
    card_number_last_four: Optional[str] = None
    exp_month: Optional[int] = None
    exp_year: Optional[int] = None
    ach_reference: Optional[str] = None
    payer_name: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    billing_city: Optional[str] = None
    billing_state: Optional[str] = None
    postal_code: Optional[str] = None
    country: Optional[str] = None
    account_number_last_four: Optional[str] = None
    routing_number_last_four: Optional[str] = None
    account_type: Optional[str] = None
    last_auto_pay_amount: Optional[str] = None
    last_auto_pay_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberStatusValuesReply(IHaveErrorField):
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    billing_type_id: Optional[int] = None
    member_status_id: Optional[int] = None
    member_status_code: Optional[str] = None
    member_status_desc: Optional[str] = None
    member_type_id: Optional[int] = None
    member_type_code: Optional[str] = None
    member_type_desc: Optional[str] = None
    current_balance: Optional[str] = None
    auto_pay_status: Optional[str] = None
    auto_pay_info: Optional[AutoPayInfo] = None
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberStatusValues:
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None

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

GET /members/StatusValues HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberStatusValuesReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AutoPayInfo>
    <AccountNumberLastFour>String</AccountNumberLastFour>
    <AccountType>String</AccountType>
    <AchReference>String</AchReference>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <BillingCity>String</BillingCity>
    <BillingState>String</BillingState>
    <CardNumberLastFour>String</CardNumberLastFour>
    <CardReference>String</CardReference>
    <CardType>String</CardType>
    <Country>String</Country>
    <ExpMonth>0</ExpMonth>
    <ExpYear>0</ExpYear>
    <LastAutoPayAmount>String</LastAutoPayAmount>
    <LastAutoPayDate>String</LastAutoPayDate>
    <PayerName>String</PayerName>
    <PaymentMethod>String</PaymentMethod>
    <PostalCode>String</PostalCode>
    <RoutingNumberLastFour>String</RoutingNumberLastFour>
  </AutoPayInfo>
  <AutoPayStatus>String</AutoPayStatus>
  <BhUserId>0</BhUserId>
  <BillingTypeId>0</BillingTypeId>
  <ClientId>0</ClientId>
  <CurrentBalance>String</CurrentBalance>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <GroupId>String</GroupId>
  <MemberStatusCode>String</MemberStatusCode>
  <MemberStatusDesc>String</MemberStatusDesc>
  <MemberStatusId>0</MemberStatusId>
  <MemberTypeCode>String</MemberTypeCode>
  <MemberTypeDesc>String</MemberTypeDesc>
  <MemberTypeId>0</MemberTypeId>
  <UserId>String</UserId>
</MemberStatusValuesReply>