Organization
Schema
| approvedTrusted | Flag that specifies whether the developer is given approved status by the organization. |
| approvedUntrusted | Flag that specifies whether untrusted developers are given approved status by the organization. |
| billingCycle | Billing cycle period. Valid values include:
|
| country | ISO 3166-2 code for the country of operation for the organization, such as |
| currency | ISO 4217 code for the "base" or accounting currency that the organization uses, such as |
| description | Brief description of the organization. |
| 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. |
| hasBroker | Flag that specifies whether the revenue is based on net. |
| 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. |
| hasSeparateInvoiceForProduct | Flag that specifies whether a separate invoice is generated for each API product. |
| id | ID of the organization. |
| issueNettingStmt | Flag that specifies whether a netting statement is generated when creating billing documents. |
| logoUrl | URL of the organization's logo. |
| name | Name of the organization. |
| netPaymentAdviceNote | Net payment advice note. |
| nettingStmtPerCurrency | Flag that specifies whether a separate netting statement is generated for each currency used. |
| regNo | Organization's registration number. The registration number is displayed at the bottom of billing documents. |
| selfBillingAsExchOrg | This feature is deprecated. |
| selfBillingForAllDev | If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider. |
| separateInvoiceForFees | Flag that specifies whether a separate invoice is published for fees. |
| status | Status of the organization. Valid values include:
|
| supportedBillingType | Developer payment model used for billing. Valid values include:
|
| taxEngineExternalId | External ID for a third-party tax engine. |
| taxModel | Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents. Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:
|
| taxNexus | The country in which the organization is registered for tax purposes. Note: 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. |
| 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 VAT registration number is displayed at the bottom of billing documents. |
| transactionalRelayURL | URL of another system to which transactions can be relayed, such as a data warehouse. |
| 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, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent. |