ID and organization for a specific application to be included in the report. If this property is not specified, all applications are included in the report.

Billing month of the report, such as JULY.

Note: This property is not valid for revenue reports.

Billing year for the report, such as 2015.

Note: This property is not valid for revenue reports.

ID and organization for a specific currency to be included in the report. If this property is not specified, all supported currencies are included in the report.

Currency for the report. Valid values include:

• LOCAL: Each line of the report is displayed using the applicable rate plan. This means that there may be multiple currencies in one report if the developers have plans that use different currencies.
• EUR: Local currency transactions are converted and displayed in Euros.
• GPB: Local currency transactions are converted and displayed in United Kingdom pounds.
• USD: Local currency transactions are converted and displayed in United States dollars.

Note: If you select EUR, GBP, or USD, the report displays all transactions using that single currency, based on the exchange rate in effect on the date of the transaction.

Developer ID or email address, and organization name for a specific developer to be included in the report. If this property is not specified, all developers are included in the report.

Custom attributes to include in the report, if defined for a developer.

Note: This property is not valid for revenue reports. Do not specify the predefined MINT_* and ADMIN_* attributes in the devCustomAttributes array.

Starting date and time of the report in UTC time. For example: 2017-01-15 01:30:00. You can omit the timestamp; if not specified it defaults to 00:00:00.

Note: This property applies only to revenue and variance reports.

Order in which sections are grouped in the report. Enter the values in the desired order: APPLICATION, BALANCE, DEVELOPER, ORG, PACKAGE, PRODUCT, and RATEPLAN.

ID of one or more API packages to include in the report. If this property is not specified, all API packages are included inthe report.

Note: This property is not valid when viewing transaction activity (/transaction-search).

ID and organization for a specific API package to be included in the report. If this property is not specified, all API packages are included in the report. This property can be specified instead of the monetizationpackageIds property.

Note: This property is not valid when viewing transaction activity (/transaction-search).

Starting date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

Note: This property applies only to variance reports.

Ending date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

Note: This property applies only to variance reports.

ID and organization for a specific API product to be included in the report. If this property is not specified, all API products are included in the report. This property can be specified instead of the productIds property.

Note: This property is not valid when viewing transaction activity (/transaction-search).

ID of one or more API products to include in the report. If this property is not specified, all API products are included in the report.

API product IDs should be specified as org-name@@@product-name. For example: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

Pricing type of rate plan to be included in the report. Valid values include:

• REVSHARE: Revenue share plan.
• REVSHARE_RATECARD: Revenue share and rate card rate plan.
• RATECARD: Rate card plan. If this property is not specified, rate plans of all pricing types are included in the report.

Type of rate plan to be included in the report. Valid values include:

• DEVELOPER: Developer rate plan.
• STANDARD: Standard rate plan.

If this property is not specified, both developer-specific and standard rate plans are included in the report.

Flag that specifies whether the reports shows the entity ID.

Flag that specifies whether the report shows revenue share percentages.

Flag that specifies whether the report is a summary.

Flag that specifies whether the report shows transaction level details.

Note: This property applies only to revenue reports.

Flag that specifies whether the report shows the type of each transaction.

Ending date and time of the report in UTC time. For example: 2017-01-15 01:30:00. You can omit the timestamp; if not specified it defaults to 00:00:00.
Note: This property applies only to revenue and variance reports.

Status of transactions to include in the report. Valid values include:

• SUCCESS: Successful transactions.
• FAILED: Failed transaction.
• FINAL: Transactions marked as final.
• REVIEW: Transaction marked as under review.

Custom transaction attributes to include in summary revenue reports. You must enable this feature in your organization. See Including custom transaction attributes in revenue summary reports.

Type of transactions to be included in the report. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, RECURRINGFEES, and TRUEUP. TRUEUPs are transactions that are used to readjust rated transactions. They are invoked when tax changes are made in the previous billing month. If this property is not specified, all transaction types are included in the report.

Flag that specifies whether the developer is given approved status by the organization.

Flag that specifies whether untrusted developers are given approved status by the organization.

Billing cycle period. Valid values include:

• 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.

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

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 specified currency is used by default. 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.

Brief description of the organization.

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.

Flag that specifies whether the revenue is based on net.

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.

Flag that specifies whether a separate invoice is generated for each API product.

ID of the organization.

Flag that specifies whether a netting statement is generated when creating billing documents.

URL of the organization's logo.

Name of the organization.

Net payment advice note.

Flag that specifies whether a separate netting statement is generated for each currency used.

Organization's registration number. The registration number is displayed at the bottom of billing documents.

This feature is deprecated.

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.

Flag that specifies whether a separate invoice is published for fees.

Status of the organization. Valid values include:

• 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.

Developer payment model used for billing. Valid values include:

• 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: In this case, the billing type defaults to PREPAID.

External ID for a third-party tax engine.

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:

• 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.

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.

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.

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

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.