संगठन की प्रोफ़ाइल मैनेज करना

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं.
जानकारी

यहां संगठन की प्रोफ़ाइल के बारे में बताया गया है. साथ ही, इसे यूज़र इंटरफ़ेस (यूआई) और एपीआई का इस्तेमाल करके मैनेज करने का तरीका बताया गया है.

संगठन की प्रोफ़ाइल के बारे में जानकारी

कमाई करने की सुविधा के शुरुआती सेटअप के दौरान, Apigee Edge कॉन्फ़िगरेशन टीम आपकी संगठन प्रोफ़ाइल सेट अप करती है.

अपने संगठन के बारे में जानकारी जोड़ने या अपडेट करने के लिए, आपको संगठन की प्रोफ़ाइल में बदलाव करना होगा. उदाहरण के लिए, आपको बिलिंग टाइप, मुद्रा की सेटिंग या टैक्स मॉडल अपडेट करना पड़ सकता है.

अपने संगठन के बारे में बुनियादी जानकारी कॉन्फ़िगर करें. इसमें ये शामिल हैं:

  • संगठन का नाम, पता, और वह देश जहां संगठन काम करता है
  • बिलिंग का टाइप (प्रीपेड, पोस्टपेड या दोनों), जैसा कि बिलिंग का टाइप समझना लेख में बताया गया है
  • बिलिंग साइकल (प्रो-रेट किया गया या कैलेंडर महीना)
  • मूल मुद्रा
  • आपके संगठन की ओर से इस्तेमाल किया जाने वाला टैक्स मॉडल

अपनी संगठन प्रोफ़ाइल को यूज़र इंटरफ़ेस (यूआई) और एपीआई का इस्तेमाल करके मैनेज किया जा सकता है. इसके बारे में यहां बताया गया है.

संगठन की प्रोफ़ाइल पेज को एक्सप्लोर करना

संगठन की प्रोफ़ाइल पेज को ऐक्सेस करें. इसके लिए, यहां दिया गया तरीका अपनाएं.

Edge

Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, संगठन की प्रोफ़ाइल वाले पेज को ऐक्सेस करने के लिए:

  1. apigee.com/edge में साइन इन करें.
  2. बाएं नेविगेशन बार में, पब्लिश करें > कमाई करें > संगठन की प्रोफ़ाइल को चुनें.

इसके बाद, संगठन की प्रोफ़ाइल पेज दिखेगा.

आंकड़े में हाइलाइट किए गए, संगठन की प्रोफ़ाइल वाले पेज पर ये काम किए जा सकते हैं:

  • संगठन की प्रोफ़ाइल की मौजूदा सेटिंग देखना
  • संगठन की प्रोफ़ाइल सेटिंग में बदलाव करें. इनमें ये शामिल हैं:

Classic Edge (Private Cloud)

Classic Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, संगठन की प्रोफ़ाइल वाले पेज को ऐक्सेस करने के लिए:

  1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
  2. सबसे ऊपर मौजूद नेविगेशन बार में, एडमिन > संगठन की प्रोफ़ाइल चुनें.

इसके बाद, संगठन की प्रोफ़ाइल पेज दिखेगा.

संगठन की प्रोफ़ाइल पेज पर जाकर, ये काम किए जा सकते हैं:

  • संगठन की प्रोफ़ाइल की मौजूदा सेटिंग देखना
  • संगठन की प्रोफ़ाइल सेटिंग में बदलाव करें. इनमें ये शामिल हैं:

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, संगठन की प्रोफ़ाइल में बदलाव करना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, संगठन की प्रोफ़ाइल में बदलाव करने के लिए:

  1. संगठन की प्रोफ़ाइल पेज पर जाएं.
  2. बदलाव करें पर क्लिक करें.
  3. नाम और जानकारी में जाकर, संगठन का नाम और कारोबार करने वाले देश का नाम बदलें.
  4. टैक्स और मुद्रा में जाकर, इन फ़ील्ड में बदलाव करें:
    फ़ील्ड ब्यौरा
    टैक्स मॉडल

    ध्यान दें: यह सिर्फ़ तब लागू होता है, जब आपने रेवेन्यू शेयर करने के लिए दर वाले प्लान सेट अप किए हों और आपको बिलिंग दस्तावेज़ जनरेट करने हों.

    रेवेन्यू शेयर करने के प्लान के लिए टैक्स मॉडल. इससे यह पता चलता है कि किस तरह के बिलिंग दस्तावेज़ों की ज़रूरत है.

    मान्य वैल्यू में ये शामिल हैं:

    • ज़ाहिर किया गया: एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के एजेंट के तौर पर काम करती है. असली उपयोगकर्ता से इकट्ठा किया गया कुल रेवेन्यू (इसमें बिक्री कर शामिल है) डेवलपर को दिया जाता है. एपीआई उपलब्ध कराने वाली कंपनी का कमीशन, डेवलपर से कमीशन इनवॉइस के तौर पर लिया जाता है. एपीआई उपलब्ध कराने वाली कंपनी, खरीदार से लिए गए सेल्स टैक्स को मैनेज नहीं करती है. सेल्स टैक्स की रिपोर्ट भेजने की ज़िम्मेदारी डेवलपर की होती है.
    • जानकारी ज़ाहिर नहीं की गई: एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के लिए एक ऐसे एजेंट के तौर पर काम करती है जिसकी जानकारी ज़ाहिर नहीं की गई है. यह कंपनी, आखिर उपयोगकर्ताओं से इकट्ठा किए गए टैक्स को काटती है और इसे स्थानीय टैक्स अथॉरिटी को चुकाती है. डेवलपर, एपीआई सेवा देने वाली कंपनी को उस नेट रेवेन्यू के लिए इनवॉइस भेजता है जो डेवलपर को मिलना है. इसमें बिक्री कर और एपीआई सेवा देने वाली कंपनी का कमीशन शामिल नहीं होता.
    • हाइब्रिड: एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के लिए एजेंट के तौर पर काम करती है. हालांकि, एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर की ओर से उसके सदस्यों से इकट्ठा किया गया सेल्स टैक्स, स्थानीय टैक्स विभाग को चुकाती है. एपीआई सेवा देने वाली कंपनी, डेवलपर को बाकी रेवेन्यू भेजती है. इसके बाद, कमीशन के लिए इनवॉइस भेजती है.
    मुद्रा

    आपके संगठन में इस्तेमाल की जा सकने वाली मुद्राएं. रेवेन्यू शेयरिंग, रेट कार्ड, और सिर्फ़ शुल्क वाले प्लान के लिए, आपके रेट प्लान के लिए डिफ़ॉल्ट मुद्रा का इस्तेमाल किया जाता है. रेट कार्ड या सिर्फ़ शुल्क वाला प्लान बनाते समय, इस्तेमाल की जाने वाली मुद्रा को बदला जा सकता है. इसके लिए, आपको उन मुद्राओं की सूची में से कोई मुद्रा चुननी होगी जिनमें यह सुविधा काम करती है. इसके अलावा, आपके पास हर मुद्रा के लिए, टॉप-अप की कम से कम वह रकम सेट करने का विकल्प होता है जिसे ऐप्लिकेशन डेवलपर, अपने प्रीपेड खाते में बाकी बैलेंस में जोड़ सकते हैं.

    कोई मुद्रा जोड़ने के लिए:

    1. मुद्रा जोड़ें पर क्लिक करें.
    2. मुद्रा फ़ील्ड में मौजूद ड्रॉप-डाउन मेन्यू से, कोई मुद्रा चुनें.
    3. इसके अलावा, कम से कम टॉप-अप फ़ील्ड में, वह कम से कम रकम सेट करें जिसे ऐप्लिकेशन डेवलपर, बताई गई मुद्रा में अपने प्रीपेड खाते के खाते में बाकी बैलेंस में जोड़ सकते हैं.
    4. जोड़ें पर क्लिक करें.
    5. अगर चाहें, तो इससे जुड़े रेडियो बटन पर क्लिक करके, इसे डिफ़ॉल्ट मुद्रा के तौर पर सेट करें.
    6. अन्य मुद्राएं जोड़ने के लिए, यह तरीका दोहराएं.

    किसी मुद्रा को मिटाने के लिए, उस मुद्रा पर कर्सर रखें जिसे मिटाना है और पर क्लिक करें.

  5. यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके नियम और शर्तें मैनेज करना लेख में बताए गए तरीके से, नियम और शर्तें मैनेज करें.
  6. सेव करें पर क्लिक करें.

एपीआई का इस्तेमाल करके, संगठन की प्रोफ़ाइल मैनेज करना

एपीआई का इस्तेमाल करके, संगठन की प्रोफ़ाइल मैनेज करें. इसके बारे में यहां बताया गया है.

एपीआई का इस्तेमाल करके संगठन की प्रोफ़ाइल देखना

/mint/organizations/{org_name} को GET अनुरोध भेजकर, अपने संगठन की प्रोफ़ाइल देखें. उदाहरण के लिए:

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

यहां जवाब का एक उदाहरण दिया गया है. दिखाए गए विकल्पों के बारे में ज़्यादा जानकारी के लिए, 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"
}

एपीआई का इस्तेमाल करके संगठन की प्रोफ़ाइल में बदलाव करना

संगठन की प्रोफ़ाइल में बदलाव करने के लिए, /mint/organizations/{org_name} पर PUT अनुरोध भेजें. संगठन की प्रोफ़ाइल में बदलाव करते समय, आपको संगठन की प्रोफ़ाइल की सभी प्रॉपर्टी के बारे में बताना होगा. सिर्फ़ उन प्रॉपर्टी के बारे में नहीं जिनमें बदलाव किया जा रहा है.

संगठन के लिए डिफ़ॉल्ट मुद्रा में बदलाव करने के लिए, currency वैल्यू को ISO 4217 मुद्रा कोड पर सेट करें. यह कोड उस मुद्रा का होना चाहिए जिसे डिफ़ॉल्ट के तौर पर सेट किया जा सकता है.

उदाहरण के लिए, यहां दिए गए एपीआई कॉल में currency को USD में और टैक्स मॉडल की सेटिंग को HYBRID में अपडेट किया गया है. उदाहरण में, अपडेट किए गए फ़ील्ड को हाइलाइट किया गया है. दिखाए गए विकल्पों के बारे में ज़्यादा जानने के लिए, API के लिए संगठन की प्रोफ़ाइल कॉन्फ़िगरेशन प्रॉपर्टी देखें.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -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" 
}' \

-u email:password

एपीआई का इस्तेमाल करके, प्रीपेड और पोस्टपेड बिलिंग टाइप कॉन्फ़िगर करना

डेवलपर खातों को इन बिलिंग टाइप का इस्तेमाल करने के लिए कॉन्फ़िगर किया जा सकता है: प्रीपेड, पोस्टपेड या दोनों.

प्रीपेड खातों के ज़रिए, डेवलपर आपके एपीआई इस्तेमाल करने के लिए, ऐडवांस में पेमेंट करते हैं. यह रकम, डेवलपर के प्रीपेड बैलेंस से काटी जाती है. यह बैलेंस, पेमेंट की सुविधा देने वाली इंटिग्रेटेड कंपनी मैनेज करती है. डेवलपर के पास, एपीआई खरीदने के लिए ज़रूरी प्रीपेड बैलेंस होना चाहिए.

पोस्टपेड खातों में, डेवलपर को महीने के आखिर में हर महीने बिल (इनवॉइस के ज़रिए) भेजा जाता है. डेवलपर, एपीआई प्रॉडक्ट के इस्तेमाल के लिए पेमेंट करता है. यह पेमेंट, इनवॉइस में शामिल प्लान के लिए तय की गई पेमेंट की शर्तों के आधार पर किया जाता है.

अपने संगठन के लिए प्रीपेड और पोस्टपेड बिलिंग टाइप कॉन्फ़िगर करने के लिए, supportedBillingType प्रॉपर्टी को इनमें से किसी एक वैल्यू पर सेट करें. इससे यह पता चलेगा कि कौनसे बिलिंग टाइप मान्य हैं: PREPAID, POSTPAID या BOTH. अगर आपने वैल्यू को BOTH पर सेट किया है, तो ऐप्लिकेशन डेवलपर या कंपनी को जोड़ते समय, डिफ़ॉल्ट वैल्यू PREPAID होगी. इस मामले में, एपीआई का इस्तेमाल करके किसी कंपनी या ऐप्लिकेशन डेवलपर के लिए बिलिंग टाइप सेट किया जा सकता है. इसके बारे में कंपनियों और ऐप्लिकेशन डेवलपर को मैनेज करना लेख में बताया गया है.

उदाहरण के लिए:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -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"
  }' \
  -u email:password

एपीआई का इस्तेमाल करके, बिलिंग साइकल कॉन्फ़िगर करना

अपने संगठन के लिए बिलिंग साइकल कॉन्फ़िगर करने के लिए, billingCycle प्रॉपर्टी को इनमें से किसी एक वैल्यू पर सेट करें:

  • PRORATED: बिलिंग, इस आधार पर की जाती है कि किसी कैलेंडर महीने में एपीआई प्रॉडक्ट का इस्तेमाल कितने दिनों तक किया गया.
  • CALENDAR_MONTH: बिल हर महीने भेजा जाता है.

उदाहरण के लिए:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -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"
  }' \
  -u email:password

एपीआई के लिए संगठन की प्रोफ़ाइल कॉन्फ़िगरेशन प्रॉपर्टी

संगठन की प्रोफ़ाइल की मदद से, एपीआई का इस्तेमाल करके कॉन्फ़िगरेशन की इन प्रॉपर्टी को सेट किया जा सकता है.

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
address

संगठन का पता. इसमें मोहल्ले का पता, शहर, राज्य, पिन कोड, देश, और यह जानकारी शामिल हो सकती है कि यह संगठन का मुख्य पता है या नहीं.

लागू नहीं नहीं
approveTrusted

इस फ़्लैग का इस्तेमाल नहीं किया जाता.

लागू नहीं नहीं
approveUntrusted

इस फ़्लैग का इस्तेमाल नहीं किया जाता.

लागू नहीं नहीं
billingCycle

बिलिंग साइकल की अवधि. वैल्यू इनमें से कोई एक हो सकती है:

  • अनुपात के आधार पर: बिलिंग, इस आधार पर की जाती है कि किसी एपीआई प्रॉडक्ट का इस्तेमाल, कैलेंडर महीने में कितने दिनों तक किया गया.
  • CALENDAR_MONTH: बिलिंग हर महीने की जाती है.

एपीआई का इस्तेमाल करके बिलिंग साइकल कॉन्फ़िगर करना लेख पढ़ें.

लागू नहीं हां
country

संगठन के कारोबार वाले देश का ISO 3166-2 कोड. जैसे, ब्राज़ील के लिए BR.

लागू नहीं हां
currency

संगठन की ओर से इस्तेमाल की जाने वाली "बेस" या लेखा मुद्रा के लिए ISO 4217 कोड. जैसे, अमेरिका के डॉलर के लिए USD.

रेवेन्यू शेयर करने वाले प्लान के लिए: आपके प्लान के लिए, बताई गई मुद्रा का इस्तेमाल किया जाता है.

रेट कार्ड (चार्जिंग मॉडल) वाले प्लान के लिए: रेवेन्यू शेयर करने वाले प्लान के लिए लागू होने वाली शर्तें ही इन प्लान पर भी लागू होती हैं. हालांकि, मुद्रा की सेटिंग को संगठन की ओर से इस्तेमाल की जा सकने वाली किसी भी मुद्रा में बदला जा सकता है.

सिर्फ़ शुल्क वाले प्लान के लिए: मुद्रा की सेटिंग को बदलकर, संगठन की ओर से इस्तेमाल की जाने वाली कोई भी मुद्रा सेट की जा सकती है.

लागू नहीं हां
description

संगठन के बारे में कम शब्दों में जानकारी.

लागू नहीं नहीं
hasBillingAdjustment

इस फ़्लैग से पता चलता है कि अडजस्टमेंट चालू हैं या नहीं. अगर यह सुविधा चालू है, तो एपीआई प्रॉडक्ट के लिए एपीआई सेवाओं की ओर से रिकॉर्ड की गई ट्रैफ़िक की जानकारी में बदलाव किया जा सकता है. वैल्यू इनमें से कोई एक हो सकती है:

  • true: अडजस्टमेंट चालू हैं.
  • false: अडजस्टमेंट की सुविधा चालू नहीं है.
लागू नहीं नहीं
hasBroker

यह फ़्लैग बताता है कि रेवेन्यू, नेट पर आधारित है या नहीं. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: रेवेन्यू, नेट के आधार पर तय किया जाता है.
  • गलत: रेवेन्यू, नेट के आधार पर नहीं होता.
लागू नहीं नहीं
hasSelfBilling

यह फ़्लैग, कमाई करने की सुविधा को रेवेन्यू के बंटवारे के स्टेटमेंट के बजाय, खुद के बिलिंग का इनवॉइस जनरेट करने का निर्देश देता है. सेल्फ़-बिलिंग इनवॉइस एक ऐसा फ़ाइनेंशियल दस्तावेज़ होता है जिसमें ऐप्लिकेशन डेवलपर को मिलने वाली रकम की जानकारी होती है. यह एपीआई देने वाली कंपनी के लिए, ऐप्लिकेशन डेवलपर की ओर से इनवॉइस के तौर पर काम करता है. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: इससे रेवेन्यू शेयर करने के स्टेटमेंट के बजाय, खुद के बिलिंग इनवॉइस जनरेट होते हैं.
  • false: इससे खुद के बिलिंग इनवॉइस जनरेट करने की सुविधा बंद हो जाती है.
लागू नहीं नहीं
hasSeparateInvoiceForProduct

यह फ़्लैग बताता है कि हर एपीआई प्रॉडक्ट के लिए अलग इनवॉइस जनरेट किया जाता है या नहीं. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: हर एपीआई प्रॉडक्ट के लिए अलग इनवॉइस जनरेट किया जाता है.
  • false: हर एपीआई प्रॉडक्ट के लिए अलग इनवॉइस जनरेट नहीं होता.
लागू नहीं नहीं
id

संगठन का आईडी.

लागू नहीं नहीं
issueNettingStmt

यह फ़्लैग यह तय करता है कि बिलिंग दस्तावेज़ बनाते समय, नेटिंग स्टेटमेंट जनरेट किया जाएगा या नहीं. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: बिलिंग दस्तावेज़ बनाते समय नेटिंग स्टेटमेंट जनरेट होता है.
  • false: बिलिंग दस्तावेज़ बनाते समय, नेटिंग स्टेटमेंट जनरेट नहीं होता है.
लागू नहीं नहीं
logoUrl

संगठन के लोगो का यूआरएल.

लागू नहीं नहीं
name

संगठन का नाम.

लागू नहीं हां
netPaymentAdviceNote

नेट पेमेंट की सलाह देने वाला नोट.

लागू नहीं नहीं
nettingStmtPerCurrency

यह फ़्लैग यह तय करता है कि इस्तेमाल की गई हर मुद्रा के लिए, अलग नेटिंग स्टेटमेंट जनरेट किया जाएगा या नहीं. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: इस्तेमाल की गई हर मुद्रा के लिए, अलग से नेटिंग स्टेटमेंट जनरेट किया जाता है.
  • false: इस्तेमाल की गई हर मुद्रा के लिए, अलग से नेटिंग स्टेटमेंट जनरेट नहीं किया जाता.
लागू नहीं नहीं
regNo

संगठन का रजिस्ट्रेशन नंबर. इस प्रॉपर्टी के लिए डाला गया नंबर, बिलिंग के दस्तावेज़ों में सबसे नीचे दिखता है.

लागू नहीं नहीं
selfBillingAsExchOrg

अगर खुद बिलिंग करने वाले इनवॉइस चालू हैं, तो यह बताता है कि एक्सचेंज संगठनों के लिए यह सुविधा चालू है या नहीं. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: एक्सचेंज संगठनों के लिए, खुद के बिल वाले इनवॉइस की सुविधा चालू है.
  • false: Self-billing invoices are not enabled for exchange organizations.
लागू नहीं नहीं
selfBillingForAllDev

अगर खुद से बिलिंग वाले इनवॉइस की सुविधा चालू है, तो इससे पता चलता है कि क्या यह सुविधा सभी ऐप्लिकेशन डेवलपर के लिए चालू है. डिफ़ॉल्ट रूप से, खुद के बिल वाले इनवॉइस सिर्फ़ उन ऐप्लिकेशन डेवलपर के लिए जनरेट किए जाते हैं जिन्होंने एपीआई सेवा देने वाली कंपनी के साथ कानूनी समझौता किया है. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: सभी ऐप्लिकेशन डेवलपर के लिए, खुद बिलिंग करने वाले इनवॉइस की सुविधा चालू है.
  • false: Self-billing invoices are not enabled for all app developers.
गलत नहीं
separateInvoiceForFees

यह फ़्लैग बताता है कि शुल्क के लिए अलग इनवॉइस पब्लिश किया गया है या नहीं. इसकी वैल्यू इनमें से कोई एक हो सकती है:

  • true: शुल्क के लिए अलग इनवॉइस पब्लिश किया जाता है.
  • गलत: शुल्क के लिए अलग इनवॉइस पब्लिश नहीं किया जाता.
गलत हां
status

संगठन की स्थिति. मान्य वैल्यू में ये शामिल हैं:

  • चालू है: संगठन का खाता, कमाई करने की सुविधा के लिए रजिस्टर किया गया है और इसका इस्तेमाल किया जा सकता है.
  • इनऐक्टिव: संगठन का खाता, कमाई करने की सुविधा के लिए रजिस्टर किया गया है, लेकिन इसका इस्तेमाल नहीं किया जा सकता.
लागू नहीं नहीं
supportedBillingType

बिलिंग के लिए इस्तेमाल किया गया डेवलपर पेमेंट मॉडल. वैल्यू इनमें से कोई एक हो सकती है:

  • PREPAID: डेवलपर, एपीआई प्रॉडक्ट के इस्तेमाल के लिए पहले से पेमेंट करता है. एपीआई प्रॉडक्ट का इस्तेमाल करने पर, डेवलपर के बैलेंस से पैसे काट लिए जाते हैं. डेवलपर के पास, एपीआई प्रॉडक्ट खरीदने के लिए ज़रूरी प्रीपेड बैलेंस होना चाहिए.
  • POSTPAID: डेवलपर को एपीआई प्रॉडक्ट इस्तेमाल करने के लिए, हर महीने (इनवॉइस के ज़रिए) बिल भेजा जाता है. डेवलपर, एपीआई प्रॉडक्ट के इस्तेमाल के लिए पेमेंट करता है. यह पेमेंट, इनवॉइस में शामिल प्लान के लिए तय की गई पेमेंट की शर्तों के आधार पर किया जाता है.
  • BOTH: दोनों तरह की बिलिंग का इस्तेमाल किया जा सकता है. डिफ़ॉल्ट रूप से, यह PREPAID पर सेट होता है.

एपीआई का इस्तेमाल करके, प्रीपेड और पोस्टपेड बिलिंग टाइप कॉन्फ़िगर करना लेख पढ़ें.

प्रीपेड हां
taxModel

ध्यान दें: यह सिर्फ़ तब लागू होता है, जब आपने रेवेन्यू शेयर करने के लिए, कीमत के हिसाब से प्लान सेट अप किए हों और आपको बिलिंग दस्तावेज़ जनरेट करने हों.

रेवेन्यू शेयर करने के प्लान के लिए टैक्स मॉडल. इससे यह पता चलता है कि किस तरह के बिलिंग दस्तावेज़ों की ज़रूरत है.

मान्य वैल्यू में ये शामिल हैं:

  • ज़ाहिर किया गया: एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के एजेंट के तौर पर काम करती है. असली उपयोगकर्ता से इकट्ठा किया गया कुल रेवेन्यू (इसमें बिक्री कर शामिल है) डेवलपर को दिया जाता है. एपीआई उपलब्ध कराने वाली कंपनी का कमीशन, डेवलपर से कमीशन इनवॉइस के तौर पर लिया जाता है. एपीआई उपलब्ध कराने वाली कंपनी, खरीदार से लिए गए सेल्स टैक्स को मैनेज नहीं करती है. सेल्स टैक्स की रिपोर्ट भेजने की ज़िम्मेदारी डेवलपर की होती है.
  • जानकारी ज़ाहिर नहीं की गई: एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के लिए एक ऐसे एजेंट के तौर पर काम करती है जिसकी जानकारी ज़ाहिर नहीं की गई है. यह कंपनी, आखिर उपयोगकर्ताओं से इकट्ठा किए गए टैक्स को काटती है और इसे स्थानीय टैक्स अथॉरिटी को चुकाती है. डेवलपर, एपीआई सेवा देने वाली कंपनी को उस नेट रेवेन्यू के लिए इनवॉइस भेजता है जो डेवलपर को मिलना है. इसमें बिक्री कर और एपीआई सेवा देने वाली कंपनी का कमीशन शामिल नहीं होता.
  • हाइब्रिड: एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के लिए एजेंट के तौर पर काम करती है. हालांकि, एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर की ओर से उसके सदस्यों से इकट्ठा किया गया सेल्स टैक्स, स्थानीय टैक्स विभाग को चुकाती है. एपीआई सेवा देने वाली कंपनी, डेवलपर को बाकी रेवेन्यू भेजती है. इसके बाद, कमीशन के लिए इनवॉइस भेजती है.
लागू नहीं हां
taxNexus

वह देश जहां संगठन को टैक्स चुकाने के लिए रजिस्टर किया गया है.

लागू नहीं नहीं
taxRegNo

संगठन का टैक्स रजिस्ट्रेशन नंबर या वैल्यू ऐडेड टैक्स (वैट) रजिस्ट्रेशन नंबर, अगर लागू हो. यह प्रॉपर्टी ज़रूरी नहीं है, क्योंकि टैक्स रजिस्ट्रेशन नंबर या वैट रजिस्ट्रेशन नंबर सभी देशों में लागू नहीं होता. इस पैरामीटर के लिए डाला गया नंबर, बिलिंग के दस्तावेज़ों में सबसे नीचे दिखता है.

लागू नहीं नहीं
transactionRelayURL

यह उस दूसरे सिस्टम का यूआरएल होता है जिस पर लेन-देन की जानकारी भेजी जा सकती है. जैसे, डेटा वेयरहाउस.

लागू नहीं नहीं
timezone

संगठन के कामकाज के लिए टाइम ज़ोन आइडेंटिफ़ायर, जैसे कि America/New_York या Europe/Paris. टाइम ज़ोन के छोटे नाम भी इस्तेमाल किए जा सकते हैं. जैसे, यूटीसी, ईएसटी (ईस्टर्न स्टैंडर्ड टाइम) या सीईटी (सेंट्रल यूरोपियन टाइम).

लागू नहीं हां

किसी कंपनी या ऐप्लिकेशन डेवलपर के लिए, कमाई करने की प्रोफ़ाइल की सेटिंग बदलना

यूज़र इंटरफ़ेस (यूआई) या एपीआई का इस्तेमाल करके, किसी कंपनी या ऐप्लिकेशन डेवलपर के लिए कमाई करने की प्रोफ़ाइल की सेटिंग को बदलें. इसके बारे में यहां बताया गया है: