Skip to main content
Skip table of contents

Response Object – AccountDetail

Field

Type

Description

SiteID

int

The PharmX allocated siteID identifying the pharmacy.

Password

string (50)

Not currently used.

Created

date/time

The (UTC) date and time the account was created on the Gateway.

DeliveryAccountNumber

string (50)

The supplier allocated account number that identifies the pharmacy to which the goods should be delivered.

SupplierId

int

The unique PharmX ID for the supplier company receiving the order (e.g, API Australia has SupplierId = 5)

StateSupplierId

int

The PharmX ID for the supplier where the supplier is sub-divided into states (e.g. , API NSW has StateSupplierId = 1107)

Active

boolean

Active flag of the account.

An inactive account is where the supplier unapproves an account rather than deleting it.

PharmacyName

string (50)

The PharmX site name/description.

AccountRoles

array of string

A list of roles assigned to the account. Roles are:

  • Order

  • Invoice

  • NDSS

MaxOrdersPerMonth

int

Not currently used.

MinimumOrderValue

decimal

If > 0.00, orders with a total value less than the MinimumOrderValue will be rejected by the gateway.

See Create Order for more information.

Note: The supplier account must also be configured in PharmX to support MinimumOrderValue.

FreightCosts

decimal

Not currently used.

Status

string (50)

The status of the account setup.

Description

string (50)

A description for the account, maps to the account “Description” in the list of site accounts in the PharmX Portal, and the “Reference” field in the “New accounts” form in the PharmX Portal.

BillToAccountNumber

string (50)

The supplier allocated account number that identifies the account to which the financial liability will be attached.

PaymentType

string (50)

  • Credit

  • Prepaid

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.