Business Object V2 API Procedures

This chapter provides an overview of business objects version 2 API procedures.

This chapter covers the following topics:

• Customer Account V2 Business Object API
• Customer Account Site V2 Business Object API
• Organization Customer V2 Business Object API
• Person Customer V2 Business Object API

Customer Account V2 Business Object API

Create Customer Account V2 Business Object API

PROCEDURE create_cust_acct_v2_bo(
    p_validate_bo_flag     IN            VARCHAR2 := fnd_api.g_true,
    p_cust_acct_v2_obj        IN            HZ_CUST_ACCT_V2_BO,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_CUST_ACCT_V2_BO,
    x_cust_acct_id         OUT NOCOPY    NUMBER,
    x_cust_acct_os         OUT NOCOPY    VARCHAR2,
    x_cust_acct_osr        OUT NOCOPY    VARCHAR2,
    px_parent_id           IN OUT NOCOPY NUMBER,
    px_parent_os           IN OUT NOCOPY VARCHAR2,
    px_parent_osr          IN OUT NOCOPY VARCHAR2,
    px_parent_obj_type     IN OUT NOCOPY VARCHAR2
  );

Update Customer Account V2 Business Object API

PROCEDURE update_cust_acct_v2_bo(
    p_cust_acct_v2_obj        IN            HZ_CUST_ACCT_V2_BO,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_CUST_ACCT_V2_BO,
    x_cust_acct_id         OUT NOCOPY    NUMBER,
    x_cust_acct_os         OUT NOCOPY    VARCHAR2,
    x_cust_acct_osr        OUT NOCOPY    VARCHAR2
  );

Save Customer Account V2 Business Object API

PROCEDURE save_cust_acct_v2_bo(
    p_validate_bo_flag     IN            VARCHAR2 := fnd_api.g_true,
    p_cust_acct_v2_obj        IN            HZ_CUST_ACCT_V2_BO,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_CUST_ACCT_V2_BO,
    x_cust_acct_id         OUT NOCOPY    NUMBER,
    x_cust_acct_os         OUT NOCOPY    VARCHAR2,
    x_cust_acct_osr        OUT NOCOPY    VARCHAR2,
    px_parent_id           IN OUT NOCOPY NUMBER,
    px_parent_os           IN OUT NOCOPY VARCHAR2,
    px_parent_osr          IN OUT NOCOPY VARCHAR2,
    px_parent_obj_type     IN OUT NOCOPY VARCHAR2
  );

Get Customer Account V2 Business Object API

PROCEDURE get_cust_acct_v2_bo(
    p_init_msg_list       IN            VARCHAR2 := fnd_api.g_false,
    p_cust_acct_id        IN            NUMBER,
    p_cust_acct_os              IN      VARCHAR2,
    p_cust_acct_osr             IN      VARCHAR2,
    x_cust_acct_v2_obj          OUT NOCOPY    HZ_CUST_ACCT_V2_BO,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_msg_count           OUT NOCOPY    NUMBER,
    x_msg_data            OUT NOCOPY    VARCHAR2
  );

Customer Account Site V2 Business Object API

Create Customer Account Site V2 Business Object API

PROCEDURE create_cust_acct_site_v2_bo(
    p_validate_bo_flag        IN            VARCHAR2 := fnd_api.g_true,
    p_cust_acct_site_v2_obj      IN            HZ_CUST_ACCT_SITE_V2_BO,
    p_created_by_module       IN            VARCHAR2,
    p_obj_source              IN            VARCHAR2 := null,
    p_return_obj_flag         IN            VARCHAR2 := fnd_api.g_true,
    x_return_status           OUT NOCOPY    VARCHAR2,
    x_messages                OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj              OUT NOCOPY    HZ_CUST_ACCT_SITE_V2_BO,
    x_cust_acct_site_id       OUT NOCOPY    NUMBER,
    x_cust_acct_site_os       OUT NOCOPY    VARCHAR2,
    x_cust_acct_site_osr      OUT NOCOPY    VARCHAR2,
    px_parent_acct_id         IN OUT NOCOPY NUMBER,
    px_parent_acct_os         IN OUT NOCOPY VARCHAR2,
    px_parent_acct_osr        IN OUT NOCOPY VARCHAR2
  );

Update Customer Account Site V2 Business Object API

PROCEDURE update_cust_acct_site_v2_bo(
    p_cust_acct_site_v2_obj      IN            HZ_CUST_ACCT_SITE_V2_BO,
    p_created_by_module       IN            VARCHAR2,
    p_obj_source              IN            VARCHAR2 := null,
    p_return_obj_flag         IN            VARCHAR2 := fnd_api.g_true,
    x_return_status           OUT NOCOPY    VARCHAR2,
    x_messages                OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj              OUT NOCOPY    HZ_CUST_ACCT_SITE_V2_BO,
    x_cust_acct_site_id       OUT NOCOPY    NUMBER,
    x_cust_acct_site_os       OUT NOCOPY    VARCHAR2,
    x_cust_acct_site_osr      OUT NOCOPY    VARCHAR2
  );

Save Customer Account Site V2 Business Object API

PROCEDURE save_cust_acct_site_v2_bo(
    p_validate_bo_flag        IN            VARCHAR2 := fnd_api.g_true,
    p_cust_acct_site_v2_obj      IN            HZ_CUST_ACCT_SITE_V2_BO,
    p_created_by_module       IN            VARCHAR2,
    p_obj_source              IN            VARCHAR2 := null,
    p_return_obj_flag         IN            VARCHAR2 := fnd_api.g_true,
    x_return_status           OUT NOCOPY    VARCHAR2,
    x_messages                OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj              OUT NOCOPY    HZ_CUST_ACCT_SITE_V2_BO,
    x_cust_acct_site_id       OUT NOCOPY    NUMBER,
    x_cust_acct_site_os       OUT NOCOPY    VARCHAR2,
    x_cust_acct_site_osr      OUT NOCOPY    VARCHAR2,
    px_parent_acct_id         IN OUT NOCOPY NUMBER,
    px_parent_acct_os         IN OUT NOCOPY VARCHAR2,
    px_parent_acct_osr        IN OUT NOCOPY VARCHAR2
  );

Get Customer Account Site V2 Business Object API

PROCEDURE get_cust_acct_site_v2_bo (
        p_init_msg_list         IN      VARCHAR2 := FND_API.G_FALSE,
        p_cust_acct_site_id     IN      NUMBER,
        p_cust_acct_site_os     IN      VARCHAR2,
        p_cust_acct_site_osr    IN      VARCHAR2,
        x_cust_acct_site_v2_obj OUT NOCOPY      HZ_CUST_ACCT_SITE_V2_BO,
        x_return_status         OUT NOCOPY      VARCHAR2,
        x_msg_count             OUT NOCOPY      NUMBER,
        x_msg_data              OUT NOCOPY      VARCHAR2
);

Organization Customer V2 Business Object API

Create Organization Customer V2 Business Object API

PROCEDURE create_org_cust_v2_bo(
    p_validate_bo_flag     IN            VARCHAR2 := fnd_api.g_true,
    p_org_cust_v2_obj         IN            HZ_org_cust_v2_bo,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_org_cust_v2_bo,
    x_organization_id      OUT NOCOPY    NUMBER
  );

Update Organization Customer V2 Business Object API

PROCEDURE update_org_cust_v2_bo(
    p_org_cust_v2_obj         IN            HZ_org_cust_v2_bo,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_org_cust_v2_bo,
    x_organization_id      OUT NOCOPY    NUMBER
  );

Save Organization Customer V2 Business Object API

PROCEDURE save_org_cust_v2_bo(
    p_validate_bo_flag     IN            VARCHAR2 := fnd_api.g_true,
    p_org_cust_v2_obj         IN            HZ_org_cust_v2_bo,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_org_cust_v2_bo,
    x_organization_id      OUT NOCOPY    NUMBER
  );

Get Organization Customer V2 Business Object API

PROCEDURE get_org_cust_v2_bo(
    p_organization_id           IN            NUMBER,
    p_organization_os           IN      VARCHAR2,
    p_organization_osr          IN      VARCHAR2,
    x_org_cust_v2_obj     OUT NOCOPY    HZ_ORG_CUST_V2_BO,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );

PROCEDURE get_v2_org_custs_created(
    p_event_id            IN            NUMBER,
    x_org_cust_v2_objs         OUT NOCOPY    HZ_ORG_CUST_V2_BO_TBL,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );

PROCEDURE get_v2_org_custs_updated(
    p_event_id            IN            NUMBER,
    x_org_cust_v2_objs         OUT NOCOPY    HZ_ORG_CUST_V2_BO_TBL,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );

PROCEDURE get_v2_org_cust_updated(
    p_event_id            IN            NUMBER,
    p_org_cust_id           IN           NUMBER,
    x_org_cust_v2_obj         OUT NOCOPY    HZ_ORG_CUST_V2_BO,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );

Person Customer V2 Business Object API

Create Person Customer V2 Business Object API

PROCEDURE create_person_cust_v2_bo(
    p_validate_bo_flag     IN            VARCHAR2 := fnd_api.g_true,
    p_person_cust_v2_obj   IN            HZ_PERSON_CUST_V2_BO,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_PERSON_CUST_V2_BO,
    x_person_id            OUT NOCOPY    NUMBER
  );

Update Person Customer V2 Business Object API

PROCEDURE update_person_cust_v2_bo(
    p_person_cust_v2_obj   IN            HZ_PERSON_CUST_V2_BO,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_PERSON_CUST_V2_BO,
    x_person_id            OUT NOCOPY    NUMBER
  );

Save Person Customer V2 Business Object API

PROCEDURE save_person_cust_v2_bo(
    p_validate_bo_flag     IN            VARCHAR2 := fnd_api.g_true,
    p_person_cust_v2_obj   IN            HZ_PERSON_CUST_V2_BO,
    p_created_by_module    IN            VARCHAR2,
    p_obj_source           IN            VARCHAR2 := null,
    p_return_obj_flag      IN            VARCHAR2 := fnd_api.g_true,
    x_return_status        OUT NOCOPY    VARCHAR2,
    x_messages             OUT NOCOPY    HZ_MESSAGE_OBJ_TBL,
    x_return_obj           OUT NOCOPY    HZ_PERSON_CUST_V2_BO,
    x_person_id            OUT NOCOPY    NUMBER
  );

Get Person Customer V2 Business Object API

PROCEDURE get_person_cust_v2_bo(
    p_init_msg_list       IN            VARCHAR2 := fnd_api.g_false,
    p_person_id           IN            NUMBER,
    p_person_os                IN       VARCHAR2,
    p_person_osr                       IN       VARCHAR2,
    x_person_cust_v2_obj  OUT NOCOPY    HZ_PERSON_CUST_V2_BO,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_msg_count           OUT NOCOPY    NUMBER,
    x_msg_data            OUT NOCOPY    VARCHAR2
  );

PROCEDURE get_v2_person_custs_created(
    p_event_id            IN            NUMBER,
    x_person_cust_v2_objs OUT NOCOPY    HZ_PERSON_CUST_V2_BO_TBL,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );

PROCEDURE get_v2_person_custs_updated(
    p_event_id            IN            NUMBER,
    x_person_cust_v2_objs OUT NOCOPY    HZ_PERSON_CUST_V2_BO_TBL,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );

PROCEDURE get_v2_person_cust_updated(
    p_event_id            IN            NUMBER,
    p_person_cust_id      IN            NUMBER,
    x_person_cust_v2_obj  OUT NOCOPY    HZ_PERSON_CUST_V2_BO,
    x_return_status       OUT NOCOPY    VARCHAR2,
    x_messages            OUT NOCOPY    HZ_MESSAGE_OBJ_TBL
  );