Organization Transactions

Organization transactions include transactions for creating, updating, deleting and retrieving an organization’s details. This also includes creating organizations which are also external suppliers.

Limited Support/End of Life Capabilities

The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact Alemba Support

OrganizationCreate Transaction

The OrganizationCreate transaction enables you to create a new organization and save its details. There is a parameter which can be set to flag an organization as an external supplier. This transaction has fields which apply to external supplier records only.

Input Parameters: ClientCompanyCreateRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Ignored

-

Ignored on create

sName

String

Yes

-

Organization Name

lParentCompany

Lookup Field

No

0

Parent Organization

sDesc

String

No

“”

Organization Description

lLocation

Lookup Field

No

0

Organization Location

lProfile

Lookup Field

No

0

Organization Profile

lServiceLevel

Lookup Field

No

0

Organization Service Level

bExternalSupplier

Boolean

No

False

Flag whether this organization is an external supplier. Values:

True = this organization is an external supplier

False = this organization is not an external supplier

lExtStatus

Lookup Field

No

0

External supplier status.

Applies to external supplier records only.

lPartition

Lookup Field

No

Analyst’s default partition

Partition in which to create the Organization

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values:ClientCompanyResponse

Argument

Type

Description

nEntityRef

Integer

Newly created organization ref

sMessage

String

Error/Warning message returned from the API transaction

Ret

APIReturn

Error/Warning number returned from the API transaction

OrganizationUpdate Transaction

The OrganizationUpdate transaction can be used to open organization details, make changes to it and save the record.

Input Parameters: ClientCompanyUpdateRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Reference number of the Organization to update

sName

String

No

(As is)

Organization Name

lParentCompany

Lookup Field

No

(As is)

Parent Organization

sDesc

String

No

(As is)

Organization Description

lLocation

Lookup Field

No

(As is)

Organization Location

lProfile

Lookup Field

No

(As is)

Organization Profile

lServiceLevel

Lookup Field

No

(As is)

Organization Service Level

bExternalSupplier

Boolean

No

(As is)

Flag whether this organization is an external supplier. Values:

True = this organization is an external supplier

False = this organization is not an external supplier

lExtStatus

Lookup Field

No

(As is)

External supplier status.

lPartition

Lookup Field

No

(As is)

Partition in which to create the Organization

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: ClientCompanyResponse

See ClientCompanyResponse for more information.

OrganizationRetrieve Transaction

The OrganizationRetrieve transaction can be used to open and view the details of an organization record. This transaction does not allow any updates to the record.

Input Parameters: ClientCompanyEntityRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Reference number of the Organization to update

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: ClientCompanyRetrieveResponse

Argument

Type

Description

Ret

APIReturn

Error/Warning message returned by API

sMessage

String

Error/Warning message returned by API

ResultSet

DataSet

ResultSet containing attribute details

OrganizationDelete Transaction

The OrganizationDelete transaction can be used to find and delete an organization record. Only the status and audit trail are updated.

Input Parameters: ClientCompanyDeleteRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Reference number of the Organization to update

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: ClientCompanyResponse

See ClientCompanyResponse for more information.