Request Object – CreditDocument

CreditNumber

string (50)

The supplier allocated identifying number for the credit.

SupplierId*

int

The unique PharmX ID for the supplier company receiving the order.

StateSupplierId

int

The PharmX ID for the supplier where the supplier is sub-divided into states.

CreditDate

date/time

The (UTC) date and time the credit was produced (supplier allocated).

CreditDueDate

date/time

The (UTC) date and time the credit is due (supplier allocated).

AccountNumber*

string (50)

The supplier allocated account number that identifies the pharmacy.

SupplierCompany*

string (50)

Supplier company name.

Can be an empty string, but not null.

SupplierABN*

string (50)

The supplier’s ABN.

Can be an empty string, but not null.

Reference

string (50)

The reference for the credit (supplier generated).

LineCount

int

The number of lines on the credit, used for message validation.

Lines

array of CreditLine

An array of credit lines.

SupplierUniqueMessageID*

guid

A GUID, uniquely identifies the message. Defined by the sender. Cannot be an empty guid, i.e. 00000000-0000-0000-0000-000000000000.

CreditLineUID*

guid

Provided by supplier as a unique reference for each credit line, otherwise set by PharmX. Assists the gateway with integrity checking and reconciliation of credit lines by the gateway and POS. Can be used by the POS application to identify and assist with correct processing of multiple lines of the same reordernumber.

InvoiceNumber*

string (50)

The invoice number to which the credit is associated to.

ReorderNumber*

string (50)

The supplier product code for the item.

RanNumber

string (50)

Return authorisation number.

Description

string (80)

The description of the product being credited.

UOM*

string (10)

The Unit of measure, currently defined values are:
EA          Each
CT          Carton
PF          Pallet (Lift)
Default will be EA (each’s) if not provided by the supplier. This defines what is meant by a supply unit of “1”.

QuantitySupplied

int

Quantity supplied.

QuantityAdjusted

int

Quantity to be credited.

TotalAdjustmentExGst

decimal

Amount credited exclusive of GST.

TotalAdjustmentGst

decimal

Adjustment GST amount.

TotalAdjustmentIncGst

decimal

Amount credited inclusive of GST.

DiscountAmount

decimal

The value of the discount applied to the line for the credit if applicable.

DiscountPercentage

decimal

The percentage of discount applied to the line for the credit if applicable.

Ean

string (50)

EAN of the line item.

Tun

string (50)

TUN of the line item.

Reason

string (50)

Reason for credit.

CustomerReference

string (50)

Reference sent for the supplier for the credit.