Response Object – GatewayCreditDocument

Id

int

The unique ID of the credit, allocated by the gateway

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

Created

date/time

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

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

SupplierABN

string (50)

Supplier ABN

Reference

string (50)

The reference for the credit (supplier generated)

LineCount

int

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

Lines

An array of CreditLine

SupplierUniqueMessageID

guid

A GUID, uniquely identifies the message. Defined by the sender.

InterfaceVersion

int

If the value is 3 then assume Gateway 3.0 messaging standards

DocumentMode

int

Defines if the credit contains header only information or full lines information. The field can take two values:

1. Zero (0), the credit will contain header only information

1. One (1), a full credit with credit lines

CreditLineUID

guid

Provided by supplier as a unique reference for each credit line, or 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.

InvoiceID

int

The original PharmX invoice ID.

OrderId

int

The original PharmX order ID, if applicable

InvoiceNumber

string (50)

The supplier allocated invoice number, depending on the supplier this may be the same for several gateway invoice documents.

ReorderNumber

string (50)

The supplier product code for the item supplied.

Description

string (80)

Description of item.

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.

QuantitySupplied

int

Quantity invoiced and supplied.

QuantityAdjusted

int

Quantity adjusted.

TotalAdjustmentExGst

decimal

Total adjustment value excluding GST.

TotalAdjustmentGst

decimal

Total GST adjustment value.

TotalAdjustmentIncGst

decimal

Total adjustment value including GST.

DiscountAmount

decimal

DiscountPercentage

decimal

Ean

string (50)

EAN of line.

Reason

string (80)

Supplier reason for credit line.