Methods: PurchaseOrder

Note: Purchase Order Budget Override Flag (element PurchaseOrder.FlagOptions.BudgetOverrideFlag) controls the response to the budget override message, which occurs when budget checking fails. Values are 1 (Yes) or 0 (No). It can be used in any method where a budget override message may occur. For example, if the budget override message occurs during the entry stage, a response of 1, or Yes, overrides the message. A response of 0, or No, results in the lines being held. If the budget override message occurs during the confirm stage, a response of 1 results in completion whereas a response of 0 results in the rejection.

Approve

Driver Type: SASI

Use this method to approve an entire order or one or more lines within a purchase order.

The approval is performed at either line or order level, according to whether line information is supplied in the payload. If the line information is supplied then SSC calls the 'Approve Line' action from the Purchase Order Entry function, otherwise the 'Approve' action is called.

Approval (whether line-level or order-level) is performed by default. If an Unapprove is required, additional data must be added to the payload. The Unapprove flag must be set to Y and a Reason Code provided. See Examples of the Approve Method.

If the PurchaseOrderLine section is included in the payload, then UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

Note: Purchase Order Reference (payload element PurchaseOrderReference) is always required for the Approve method. Reason Code is required if Unapprove is used.

ConfirmLineOrder

Driver Type: SASI

Use this method to confirm one or more purchase order lines. If no line numbers are specified in the payload, the entire order, including all lines, is confirmed.

PurchaseOrderReference is mandatory. If the PurchaseOrderLine section is included in the payload, UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

CreateOrAmend

Driver Type: SASI

This method creates a purchase order if it does not exist already, and amends it if it does.

Note:

To create/amend a temporary address via the Purchase Order CreateOrAmend method an extra setting must be added to the payload. Any temporary address data is ignored unless a value is provided for payload element PurchaseOrder.PurchaseOrderLine.TemporaryAddress.POAddressType.PurchaseAddressType to indicate the type of temporary address being created/amended.

Valid values are:

1 - Supplier address
2 - Invoice address
3 - Order address
4 - Delivery address.

Note: If amending a purchase order, PurchaseOrderReference must be provided. If PurchaseOrderReference is specified in the payload, but there is no existing order with this reference, then a new order is created. However, the new order may have a different transaction reference, depending on the Purchase Transaction Type used, i.e. if the associated transaction reference format does not contain any items for a user to specify, then the purchase order reference will be system generated, and the existing payload values are not used.

DeleteLineOrder

Driver Type: SASI

Use this method to delete one or more purchase order lines. If no line numbers are specified in the payload, the entire order, including all lines, is deleted.

PurchaseOrderReference is mandatory. If the PurchaseOrderLine section is included in the payload, UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

DeleteLines

Driver Type: SASI

Use this method to delete specific lines from a purchase order.

PurchaseOrderReference is mandatory and either UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

DeleteWholeOrder

Driver Type: SASI

Use this method to delete a purchase order and all lines.

PurchaseOrderReference is mandatory.

HoldLineOrder

Driver Type: SASI

Use this method to hold one or more purchase order lines. If no line numbers are specified in the payload, the entire order, including all lines, is held.

PurchaseOrderReference is mandatory. If the PurchaseOrderLine section is included in the payload, UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

ReleaseLineOrder

Driver Type: SASI

Use this method to release one or more purchase order lines. If no line numbers are specified in the payload, the entire order including all lines is released.

PurchaseOrderReference is mandatory. If the PurchaseOrderLine section is included in the payload, UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

Query

Driver Type: SASI

Use this method to obtain purchase order details or to extract purchase order data from SunSystems.