UserWS
Property Type Description
id Integer Unique identifier for this record. ach AchDTO ACH Payment details saved for the
User. If available, the ACH info can be used during Automatic Payment
processing.
autoRecharge api:java.lang.String Amount by which the customer's account will be autorecharged when depleted (the amount can be handled as a api:java.math.BigDecimal Java type via the setAutoRechargeAsDecimal() and getAutoRechargeAsDecimal() methods. The system should be configured to use AutoRecharge feature.
automaticPaymentType api:java.lang.Integer Integer value to determine which of the three payment methods does the customer want to apply for automatic payment processing. Refer to Appendix A for acceptable values. balanceType api:java.lang.Integer The type of dynamic balance for this
user. Refer to Appendix A for acceptable values.
blacklistMatches String Lists any blacklist matches for this user. See the jBilling User Guide for more information on blacklists. childIds Integer The identifiers of any subaccounts
for this user.
companyName api:java.lang.String User's company name.
contact ContactWS The primary contact information for this user.
createDatetime api:java.util.Date Creation date of this data record. creditCard CreditCardDTO Credit card information for this user.
Not required for the user creation process.
creditLimit Double The credit limit. Only valid if balanceType is of credit limit type. currencyId api:java.lang.Integer Contains the currency code for this
user. Refer to Appendix A for acceptable values.
customerId api:java.lang.Integer Reference to the Customer information for this user.
deleted api:java.lang.Integer If the record has been deleted, this field contains '1', otherwise it contains '0'. Note that deletion cannot be carried out by simply setting a '1' in this field.
dueDateUnitId api:java.lang.Integer Period Unit of this Customer's Invoice due date. Refer to Appendix A for Period Unit acceptable values. dueDateValue api:java.lang.Integer Customer specific Invoice Due date
value
dynamicBalance api:java.lang.String String representation of this Customer's dynamic balance. The dynamic balance. If balanceType is credit limit, this represents the amount of credit used on the account. If balanceType is pre paid, this represents the pre paid balance remaining.
excludeAgeing Boolean Boolean value to indicate excluding this User/Customer from the Ageing process
failedAttempts api:java.lang.Integer Number of login attempts that have been failed by this user (i.e., the user has entered the wrong password). invoiceChild Boolean true if this is a subaccount (child of
a parent account), but this user will still receive invoices.
invoiceDeliveryMethodId api:java.lang.Integer Reference ID for one of the Invoice Delivery Methods. See appendix for acceptable values.
isParent Boolean true if this record is a "parent" user. A parent user can have
subaccounts (children). language api:java.lang.String Name of the language (i.e.
"English").
languageId api:java.lang.Integer Contains the preferred language code for this user. Refer to Appendix A for acceptable values.
lastLogin api:java.util.Date Date of the last login performed by this user.
lastStatusChange api:java.util.Date Date of the last status change incurred by this user.
mainRoleId api:java.lang.Integer The level of privilege granted to the user when logged into the system. See Appendix A for acceptable values.
nextInvoiceDate api:java.util.Date The earliest next billable date for this user's Orders.
owingBalance api:java.math.BigDecimal A realtime calculated owing balance. (All Invoices All Payments)
parentId api:java.lang.Integer If the user belongs to a parent record, this field contains the identifier of the parent record. partnerId api:java.lang.Integer Identifier of the partner this user
belongs to.
password api:java.lang.String Authenticates the user's identity during login. This could be meaningless if the password is encrypted.
role api:java.lang.String The name of the User's role (i.e. "Clerk" or "Customer").
status api:java.lang.String Name of the User's current status (i.e. "Suspended" or "Active"). statusId api:java.lang.Integer Current status identifier of the user.
See Appendix A for acceptable values.
subscriberStatusId api:java.lang.Integer Subscriber status for this user. See Appendix A for acceptable values. userIdBlacklisted Boolean true if the user id is blacklisted. See
the jBilling User Guide for more information on blacklists. userName api:java.lang.String Identifies the user during login. useParentPricing Boolean Selecting this field will indicate to the
system that you want the child account to take on the same rates that the parent carries for particular products.
metaFields MetaFieldValueWS User define fields.
mainSubscription MainSubscriptionWS The Main Subscription field allows a billing administrator to select any billing period required for a specific customer.
CreditCardDTO
Property Type Description
deleted api:java.lang.Integer If the record has been deleted, this field contains '1', otherwise it contains '0'. Note that deletion cannot be carried out by simply setting a '1' in this field.
Usually, card expiration dates are expressed in month/year form, such as "05/11" or "May 2011". This field contains the last day the card is valid, in this example, "05/31/2011". id api:java.lang.Integer Unique identifier for this record. name api:java.lang.String Credit card owner's name. This is
the name that appears physically on the credit card.
number api:java.lang.String Credit card number. Usually, a 16 digit number.
securityCode api:java.lang.Integer CCV (Credit Card Verification) code of the credit card.
type api:java.lang.Integer Credit Card type. See Appendix A for acceptable values.
ContactWS
Property Type Description
address1 api:java.lang.String First line for the address. address2 api:java.lang.String Second line for the address. city api:java.lang.String City of this contact.
contactTypeDescr api:java.lang.String Description of the contact type of this contact namely 'Primary'
contactTypeId api:java.lang.Integer Identifier for the type id of the Contact i.e. id of contact_type table. A contact has atleast one 'Primary' contact type and may have more Contact Types.
countryCode api:java.lang.String Country code for this contact (Appendix A contains a list of acceptable country codes). createDate api:java.util.Date Date this contact record was first
created.
deleted api:java.lang.Integer If the record has been deleted, this field contains '1', otherwise it contains '0'. Note that deletion cannot be carried out by simply setting a '1' in this field.
email api:java.lang.String Email address of this contact. faxAreaCode api:java.lang.Integer Area Code for the fax number, if any.
faxCountryCode api:java.lang.Integer Country Code for the fax number, if any.
faxNumber api:java.lang.String Fax number.
firstName api:java.lang.String First name of this contact. id api:java.lang.Integer Unique identifier of this contact. include api:java.lang.Integer 1 if this contact is marked as
included in notifications. initial api:java.lang.String Middle name initials, if any. lastName api:java.lang.String Last name of this Contact.
organizationName api:java.lang.String Name of the organization the contact belongs to.
phoneAreaCode api:java.lang.Integer Phone number Area Code. phoneCountryCode api:java.lang.Integer Phone number Country Code. phoneNumber api:java.lang.String Phone number.
postalCode api:java.lang.String ZIP Code for the contact's address. stateProvince api:java.lang.String State or Province of the contact's
address.
title api:java.lang.String Title for the contact, such as "Mr." or "Dr.".
type Integer User define contact type ex. primary contact, secondary contact.
UserTransitionResponseWS
Property Type Description
fromStatusId api:java.lang.Integer Status of the subscription before the transition took place. See Appendix A for acceptable values.
id api:java.lang.Integer Unique identifier for the transition record.
toStatusId api:java.lang.Integer Status of the subscription after the transition took place.
transitionDate api:java.util.Date Date and time the transition took place.
userId api:java.lang.Integer Identifies the user account that suffered the subscription status change.