Send Docs Feedback

Edit the organization profile

About the organization profile

The Apigee Edge configuration team initally sets up your organization profile. The profile contains basic information about your organization, such as:

  • Your organization's name, address, and country of operation.
  • Tax model used by your organization — the tax model dictates the type of billing documents that monetization produces for your organization.
  • Base currency that your organization uses.
  • Basic billing configuration options, such as billing cycle (pro-rated or calendar month), billing type (pre-paid or post-paid, or both), and so on. (For more information about billing configuration, see Configure billing documents.)

After the profile is created, you need to edit it to add and update information about your organization, as appropriate. For example, you may need to update the tax model and currency settings.  You can update your organization profile using the UI and API, as described in the following sections:

Editing the organization profile using the UI

To edit the organization profile:

  1. Login to enterprise.apigee.com. This opens the Edge Management UI.
  2. On the Admin tab, select Organization Profile.

    This opens the Organization Profile page.

  3. Click Edit on the Organization Profile page, and enter the following information.

    For telecommunications companies, the Organization Profile page uses "Operator" in the label of various fields (such as "Operator Structure"). For non-telecommunications companies, the label "Organization" is used (as in "Organization Structure").

    Field Description
    Operator/Organization
    Name and Information
    Operator/Organization Name

    Name of your organization.

    Country

    Country of operation of your organization.

    Tax and Currency
    Tax Model

    This field only applies if you set up revenue sharing plans and you want monetization to generate billing documents. It refers to the tax model you want to use for those plans.

    Tax model that dictates the type of billing documents that monetization produces.

    Select one of the following:

    • Disclosed
    • Undisclosed
    • Hybrid

    Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.

    Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).

    Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.

    Currency

    Currencies that your organization supports.

    To add a currency, click Add Currency, and select a currency from the drop-down menu. Click Default if you want this currency to be the default currency. Click Add Currency and make a currency selection from the drop-down menu for each additional currency that you want to add (you can list multiple currencies).

    The currencies are used as follows:

    For revenue sharing plans, the default currency is used for your rate plan.

    For rate card (charging model) and fee only plans: The same applies as for revenue sharing plans. However, when you create the plan, you can change which currency to use by selecting from a list of supported currencies.

    To delete a currency, click Delete next to the currency.

    You cannot delete a supported currency that is used by a developer or rate plan.

Viewing the organization profile using the API

You can view your organization profile by issuing a GET request to /organizations/{org_name}. For example:

$ curl -H "Accept: application/json" \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-u email:password

The following provides an example of the response. For more information about the options shown, see Organization profile configuration settings for the API.

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg
",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

Editing the organization profile using the API

Using an API, you can update any of the values in the organization profile with the exception of the organization structure.

To update the organization profile, issue a PUT request to /organizations/{org_name}. When you make the update, you need to specify all the organization profile settings, not only the settings you update.

To update the default currency for the organization, set the currency value to the name (that is, the ISO 4217 currency code) of the supported currency that you want to make the default.

For example, the following API call updates the currency to USD and the tax model setting to HYBRID (the updated fields are highlighted in the example). For more information about the options shown, see Organization profile configuration settings for the API.

$ curl  -H "Content-Type: application/json" -X PUT -d \
'{ 
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", 
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
-u email:password

Organization profile configuration settings for the API

The organization profile enables you to set the following configuration options using the API. Many of the options described below are relevant to billing configuration. For more information, see Create billing documents.

Name Description Default Required?
address

Organization’s address, which can include the street address, city, state, zip code, country, and an indication whether this is the primary address for the organization.

N/A No
approveTrusted

Flag that specifies whether the developer is given approved status by the organization. The value can be either of the following:

  • true. The developer is given approved status by the organization.
  • false. The developer is not given approved status by the organization.
N/A No
approveUntrusted

Flag that specifies whether untrusted developers are given approved status by the organization. The value can be either of the following:

  • true. Untrusted developers are given approved status by the organization.
  • false. Untrusted developers are not given approved status by the organization.
N/A No
billingCycle

Billing cycle period. The value can be one of the following:

  • PRORATED. Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH. Billing is done monthly.
N/A Yes
country

ISO 3166-2 code for the country of operation for the organization, such as BR for Brazil.

N/A Yes
currency

ISO 4217 code for the "base" or accounting currency that the organization uses (such as USD for Unites States dollar).

For revenue sharing plans: The specified currency is used for your plan.

For rate card (charging model) plans: The same applies as for revenue sharing plans. However, you can change the currency setting to any currency supported by the organization.

For fees only plans: You can change the currency setting to any currency supported by the organization.

N/A Yes
description

Brief description of the organization.

N/A No
hasBillingAdjustment

Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API Services for your API products The value can be either of the following:

  • true. Adjustments are enabled.
  • false. Adjustments are not enabled.
N/A No
hasBroker

Flag that specifies whether the revenue is based on net. The value can be either of the following:

  • true. The revenue is based on net.
  • false. The revenue is not based on net.
N/A No
hasSelfBilling

Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer. The value can be either of the following:

  • true. Generates self-billing invoices instead of revenue share statements.
  • false. Disables self-billing invoices
N/A No
hasSeparateInvoiceForProduct

Flag that specifies whether a separate invoice is generated for each API product. The value can be either of the following:

  • true. A separate invoice is generated for each API product.
  • false. A separate invoice is not generated for each API product.
N/A No
id

ID of the organization.

N/A No
issueNettingStmt

Flag that specifies whether a netting statement is generated when creating billing documents. The value can be either of the following:

  • true. A netting statement is generated when creating billing documents.
  • false. A netting statement is not generated when creating billing documents.
N/A No
logoUrl

URL of the organization's logo.

N/A No
name

Name of the organization.

N/A Yes
netPaymentAdviceNote

Net payment advice note.

N/A No
nettingStmtPerCurrency

Flag that specifies whether a separate netting statement is generated for each currency used. The value can be either of the following:

  • true. A separate netting statement is generated for each currency used.
  • false. A separate netting statement is not generated for each currency used.
N/A No
regNo

Organization's registration number. The number you enter for this property is displayed at the bottom of billing documents.

N/A No
selfBillingAsExchOrg

If self-billing invoices are enabled, indicates whether it is enabled for exchange organizations. The value can be either of the following:

  • true. Self-billing invoices are enabled for exchange organizations.
  • false. Self-billing invoices are not enabled for exchange organizations.
N/A No
selfBillingForAllDev

If self-billing invoices are enabled, indicates whether it is enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider. The value can be either of the following:

  • true. Self-billing invoices are enabled for all developers.
  • false. Self-billing invoices are not enabled for all developers.
false No
separateInvoiceForFees

Flag that specifies whether a separate invoice is published for fees. The value can be either of the following:

  • true. A separate invoice is published for fees.
  • false. A separate invoice is not published for fees.
false Yes
status

Status of the organization. The value can be one of the following:

  • ACTIVE. The organization account is registered in monetization and is available for use.
  • INACTIVE. The organization account is registered in monetization, but is not available for use.
N/A No
supportedBillingType

Developer payment model used for billing. The value can be one of the following:

  • PREPAID. The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID. The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH. Defaults to PREPAID.
PREPAID Yes
taxModel

This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents. The property refers to the tax model you want to use for those plans.

The tax model dictates the type of billing documents that monetization produces. This applies to an individual operator or organization.

The value can be one of the following:

  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.
  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).
  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.
N/A Yes
taxNexus

The country in which the organization is registered for tax purposes.

If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization.

 

N/A No
taxRegNo

Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The number you enter for this parameter is displayed at the bottom of billing documents.

N/A No
transactionRelayURL

URL of another system to which transactions can be relayed, such as a data warehouse.

N/A No
timezone

The time zone identifier for the organization’s operations, such as America/New_York. Or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported

Use caution when updating the timezone setting in an organization profile. Changing the timezone setting can impact date and time-based events such as when a rate plan starts and ends and when notifications are sent.

N/A Yes