Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Data Labeling API

The Data Labeling APIs help you to label your existing data with organization(s) in Zuora. Once you turned on Multi Org feature, if you don't label your existing data, they are simply unlabeled, and unlabeled data can be accessed by all organizations in your tenant.To limit the access of your existing data, you need to label them with organization(s) you defined in the organization hierarchy management setting page. Once labeled, the data can only be accessed by users who have been granted with the labeled organization(s).Note that you have to enable the "Multi Org" feature before using the Data Labeling APIs. ### General guidelines* Firstly, create the org hierarchy and determine the data categorization strategy, for example, by currency, by region, by custom fields etc.* You have to migrate all customer accounts before labeling products in the product catalog* You can leave the users at the root, just so long as you understand that the user would have access to all the Org Units within the Multi-org enabled tenant* Currently, you need to manually label existing Journal Runs, JournalEntry, and AccountingPeriod objects by editing, tell us your use case if you want to automate this process.### Order of object labelingExcept for `Account` and `Product`, there are no dependencies between objects, users can label them in parallel.But please keep in mind that the data access control ensues from the object labeling. For example, if you label a scheduled `BillRun` with `US` org, when it's triggered next time, the bill run will only pick up customer accounts of the `US` org, not others.Likewise, labeling a user will change the user's visible data scope, for example, an `EU` user won't be able to see `US` accounts anymore.

Zuora Data Labeling API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Labeling. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

2 operations 2 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Data Labeling 2

The Data Labeling APIs help you to label your existing data with organization(s) in Zuora. Once you turned on Multi Org feature, if you don't label your existing data, they are si…

POST
/v1/multi-organizations/data-labeling-job
Submit a data labeling job
POST_DataLabelingJob 7 params → 200400
GET
/v1/multi-organizations/data-labeling-job/{job-id}
Retrieve a data labeling job
GET_DataLabelingJob 6 params → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are GetDataLabelingJobResponse (6 properties), SubmitDataLabelingJobRequest (6 properties), CommonErrorResponse (4 properties), SubmitDataLabelingJobResponse (3 properties). Each schema is shown below with its type and property counts.

SubmitDataLabelingJobResponse
object
3 properties
CommonErrorResponse
object
4 properties
SubmitDataLabelingJobRequest
object
6 properties 2 required
GetDataLabelingJobResponse
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-data-labeling-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API