Methods: Customer

Amend

Note: In a Financials Only business unit, the fields DefaultCarrier, DefaultDispatchWarehouse, DefaultReturnLocation, DefaultSalesDefinitionCode, DefaultSalesperson and PrimaryDeliveryAddress are not applicable. Therefore, payload values for these fields will not be applied when using the Amend, BulkCreateOrAmend, Create and CreateOrAmend methods.

Driver Type: SASI

Use this method to amend one or more customers. If a customer does not exist, an error message is produced and the payload is rejected.

Note: You cannot use this method to amend the status of a Customer. Instead, use one of the Open, Hidden, SuspendedHeld or Closed methods.

BulkCreateOrAmend

Note: In a Financials Only business unit, the fields DefaultCarrier, DefaultDispatchWarehouse, DefaultReturnLocation, DefaultSalesDefinitionCode, DefaultSalesperson and PrimaryDeliveryAddress are not applicable. Therefore, payload values for these fields will not be applied when using the Amend, BulkCreateOrAmend, Create and CreateOrAmend methods.

Driver Type: DJI

Use this method for the bulk loading of customer data or bulk amendment of customer data, or where performance is critical.

Note: Although the SASI method accepts dates and periods with slashes, the DJI method does not and expects dates in ddmmyyyy format and periods in pppyyyy format.

You cannot use this method to amend the status of a customer. Instead, use one of the Open, Hidden, SuspendedHeld or Close methods.

Closed

Driver Type: SASI

Use this method to amend the status of one or more customers to Closed.

Create

Note: In a Financials Only business unit, the fields DefaultCarrier, DefaultDispatchWarehouse, DefaultReturnLocation, DefaultSalesDefinitionCode, DefaultSalesperson and PrimaryDeliveryAddress are not applicable. Therefore, payload values for these fields will not be applied when using the Amend, BulkCreateOrAmend, Create and CreateOrAmend methods.

Driver Type: SASI

Use this method to create one or more customers. If a customer already exists, an error message is produced and the payload is rejected.

CreateAsDraft

Driver Type: SASI

Use this method to create one or more draft customer records.

CreateOrAmend

Note: In a Financials Only business unit, the fields DefaultCarrier, DefaultDispatchWarehouse, DefaultReturnLocation, DefaultSalesDefinitionCode, DefaultSalesperson and PrimaryDeliveryAddress are not applicable. Therefore, payload values for these fields will not be applied when using the Amend, BulkCreateOrAmend, Create and CreateOrAmend methods.

Driver Type: SASI

Use this method to create or amend one or more customers. A customer is created if it does not exist and amended if it does. Both the Create and Amend methods require you to know in advance if a customer exists, whereas this method can be used if you are unsure.

Note: You cannot use this method to amend the status of a customer. Instead, use one of the Open, Hidden, SuspendedHeld or Closed methods.

CreateReplaceOrDelete

Driver Type: SASI

Use this method to synchronize customers. A customer is created if it does not exist already and replaced if it does. If the customer does not exist in the originating business unit, it is deleted.

Delete

Driver Type: SASI

Use this method to delete one or more customers.

DeleteChildData

Driver Type: SASI

Use this method to delete child data (Delivery Addresses, Invoice Addresses, Contact Addresses, Acknowledgement Addresses, Customer Document Formats) but retains the parent record (Customer).

Note: Standard Text should be deleted using the Delete method for the StandardTextLanguageVariants component.

Hidden

Driver Type: SASI

Use this method to amend the status of one or more customers to Hidden.

Open

Driver Type: SASI

Use this method to amend the status of one or more customers to Open.

Query

Driver Type: Export

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

SuspendedHeld

Driver Type: SASI

Use this method to amend the status of one or more customers to Suspended/Held.