This component runs the Addresses (ADD) function.
Note: When using Create, you must supply an
address code which does not currently exist.
Methods
- Amend
- Driver Type: SASI
- Use this method to amend the details of one or more addresses. If an address does not
exist, an error message is produced and the payload rejected.
- BulkCreateOrAmend
- Driver Type: DJI
- Use this method for the bulk loading of addresses or bulk amendment of addresses, or
where performance is critical.
- Closed
- Driver Type: SASI
- Use this method to change the status of one or more addresses to closed.
- Create
- Driver Type: SASI
- Use this method to create one or more addresses. If an address 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 Addresses.
- CreateOrAmend
- Driver Type: SASI
- Use this method to create or amend one or more addresses. An address is created if it
does not exist and amended if it does. Both the Create and Amend methods require you to
know if the address already exists, whereas this method can be used if you are
unsure.
- CreateReplaceOrDelete
- Driver Type: SASI
- Use this method to synchronize addresses between business units. An address is created
in the target business unit if it does not already exist and replaced if it does. If the
address does not exist in the originating business unit, it is deleted.
- Delete
- Driver Type: SASI
- Use this method to delete one or more addresses.
- Hidden
- Driver Type: SASI
- Use this method to change the status of one or more addresses to Hidden.
- Open
- Driver Type: SASI
- Use this method to change the status of one or more addresses to Open.
- Query
- Driver Type: Export
- Use this method to obtain address details or to extract address data from SunSystems.
- SuspendedHeld
- Driver Type: SASI
- Use this method to change the status of one or more addresses to Suspended/Held.
Mandatory fields
A value must be supplied for these payload elements, unless you are using
the Query method, in which case they are optional:
- Address Code - payload element
<AddressCode>
- Short Heading - payload element
<ShortHeading>
When creating or amending analysis entries, a value must be supplied for the
Analysis Code - payload element <VAddrCatAnalysis_AnlCode>.
Note: At runtime the component validates
the payload contents to ensure that the values supplied are correct. Various combinations of
values may require other elements in the payload to be specified before the payload can be
processed successfully.
Related data
- Address Analysis 1-10
- EDI Profile
- Tax 1 - 10